Interface RdsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
-
For the alphabetical list of API actions, see API Actions.
-
For the alphabetical list of data types, see Data Types.
-
For a list of common query parameters, see Common Parameters.
-
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
-
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
-
For more information about how to use the Query API, see Using the Query API.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddRoleToDBCluster
(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.addRoleToDBCluster
(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.addRoleToDBInstance
(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest) Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.addRoleToDBInstance
(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest) Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.addSourceIdentifierToSubscription
(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.addSourceIdentifierToSubscription
(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource.addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource.applyPendingMaintenanceAction
(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).applyPendingMaintenanceAction
(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).authorizeDBSecurityGroupIngress
(Consumer<AuthorizeDbSecurityGroupIngressRequest.Builder> authorizeDbSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.authorizeDBSecurityGroupIngress
(AuthorizeDbSecurityGroupIngressRequest authorizeDbSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.backtrackDBCluster
(Consumer<BacktrackDbClusterRequest.Builder> backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.backtrackDBCluster
(BacktrackDbClusterRequest backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.static RdsAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aRdsAsyncClient
.cancelExportTask
(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest) Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.cancelExportTask
(CancelExportTaskRequest cancelExportTaskRequest) Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.copyDBClusterParameterGroup
(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.copyDBClusterParameterGroup
(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.copyDBClusterSnapshot
(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.copyDBClusterSnapshot
(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.copyDBParameterGroup
(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) Copies the specified DB parameter group.copyDBParameterGroup
(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.default CompletableFuture
<CopyDbSnapshotResponse> copyDBSnapshot
(Consumer<CopyDbSnapshotRequest.Builder> copyDbSnapshotRequest) Copies the specified DB snapshot.default CompletableFuture
<CopyDbSnapshotResponse> copyDBSnapshot
(CopyDbSnapshotRequest copyDbSnapshotRequest) Copies the specified DB snapshot.default CompletableFuture
<CopyOptionGroupResponse> copyOptionGroup
(Consumer<CopyOptionGroupRequest.Builder> copyOptionGroupRequest) Copies the specified option group.default CompletableFuture
<CopyOptionGroupResponse> copyOptionGroup
(CopyOptionGroupRequest copyOptionGroupRequest) Copies the specified option group.static RdsAsyncClient
create()
Create aRdsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createBlueGreenDeployment
(Consumer<CreateBlueGreenDeploymentRequest.Builder> createBlueGreenDeploymentRequest) Creates a blue/green deployment.createBlueGreenDeployment
(CreateBlueGreenDeploymentRequest createBlueGreenDeploymentRequest) Creates a blue/green deployment.createCustomDBEngineVersion
(Consumer<CreateCustomDbEngineVersionRequest.Builder> createCustomDbEngineVersionRequest) Creates a custom DB engine version (CEV).createCustomDBEngineVersion
(CreateCustomDbEngineVersionRequest createCustomDbEngineVersionRequest) Creates a custom DB engine version (CEV).default CompletableFuture
<CreateDbClusterResponse> createDBCluster
(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.default CompletableFuture
<CreateDbClusterResponse> createDBCluster
(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.createDBClusterEndpoint
(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.createDBClusterEndpoint
(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.createDBClusterParameterGroup
(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterParameterGroup
(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterSnapshot
(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.createDBClusterSnapshot
(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.createDBInstance
(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.createDBInstance
(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.createDBInstanceReadReplica
(Consumer<CreateDbInstanceReadReplicaRequest.Builder> createDbInstanceReadReplicaRequest) Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.createDBInstanceReadReplica
(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest) Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.createDBParameterGroup
(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.createDBParameterGroup
(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.default CompletableFuture
<CreateDbProxyResponse> createDBProxy
(Consumer<CreateDbProxyRequest.Builder> createDbProxyRequest) Creates a new DB proxy.default CompletableFuture
<CreateDbProxyResponse> createDBProxy
(CreateDbProxyRequest createDbProxyRequest) Creates a new DB proxy.createDBProxyEndpoint
(Consumer<CreateDbProxyEndpointRequest.Builder> createDbProxyEndpointRequest) Creates aDBProxyEndpoint
.createDBProxyEndpoint
(CreateDbProxyEndpointRequest createDbProxyEndpointRequest) Creates aDBProxyEndpoint
.createDBSecurityGroup
(Consumer<CreateDbSecurityGroupRequest.Builder> createDbSecurityGroupRequest) Creates a new DB security group.createDBSecurityGroup
(CreateDbSecurityGroupRequest createDbSecurityGroupRequest) Creates a new DB security group.createDBShardGroup
(Consumer<CreateDbShardGroupRequest.Builder> createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database.createDBShardGroup
(CreateDbShardGroupRequest createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database.createDBSnapshot
(Consumer<CreateDbSnapshotRequest.Builder> createDbSnapshotRequest) Creates a snapshot of a DB instance.createDBSnapshot
(CreateDbSnapshotRequest createDbSnapshotRequest) Creates a snapshot of a DB instance.createDBSubnetGroup
(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group.createDBSubnetGroup
(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group.createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an RDS event notification subscription.createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an RDS event notification subscription.createGlobalCluster
(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions.createGlobalCluster
(CreateGlobalClusterRequest createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions.createIntegration
(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.createIntegration
(CreateIntegrationRequest createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.createOptionGroup
(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest) Creates a new option group.createOptionGroup
(CreateOptionGroupRequest createOptionGroupRequest) Creates a new option group.createTenantDatabase
(Consumer<CreateTenantDatabaseRequest.Builder> createTenantDatabaseRequest) Creates a tenant database in a DB instance that uses the multi-tenant configuration.createTenantDatabase
(CreateTenantDatabaseRequest createTenantDatabaseRequest) Creates a tenant database in a DB instance that uses the multi-tenant configuration.deleteBlueGreenDeployment
(Consumer<DeleteBlueGreenDeploymentRequest.Builder> deleteBlueGreenDeploymentRequest) Deletes a blue/green deployment.deleteBlueGreenDeployment
(DeleteBlueGreenDeploymentRequest deleteBlueGreenDeploymentRequest) Deletes a blue/green deployment.deleteCustomDBEngineVersion
(Consumer<DeleteCustomDbEngineVersionRequest.Builder> deleteCustomDbEngineVersionRequest) Deletes a custom engine version.deleteCustomDBEngineVersion
(DeleteCustomDbEngineVersionRequest deleteCustomDbEngineVersionRequest) Deletes a custom engine version.default CompletableFuture
<DeleteDbClusterResponse> deleteDBCluster
(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.default CompletableFuture
<DeleteDbClusterResponse> deleteDBCluster
(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.deleteDBClusterAutomatedBackup
(Consumer<DeleteDbClusterAutomatedBackupRequest.Builder> deleteDbClusterAutomatedBackupRequest) Deletes automated backups using theDbClusterResourceId
value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.deleteDBClusterAutomatedBackup
(DeleteDbClusterAutomatedBackupRequest deleteDbClusterAutomatedBackupRequest) Deletes automated backups using theDbClusterResourceId
value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.deleteDBClusterEndpoint
(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.deleteDBClusterEndpoint
(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.deleteDBClusterParameterGroup
(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterParameterGroup
(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterSnapshot
(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.deleteDBClusterSnapshot
(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.deleteDBInstance
(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) Deletes a previously provisioned DB instance.deleteDBInstance
(DeleteDbInstanceRequest deleteDbInstanceRequest) Deletes a previously provisioned DB instance.deleteDBInstanceAutomatedBackup
(Consumer<DeleteDbInstanceAutomatedBackupRequest.Builder> deleteDbInstanceAutomatedBackupRequest) Deletes automated backups using theDbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.deleteDBInstanceAutomatedBackup
(DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest) Deletes automated backups using theDbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.deleteDBParameterGroup
(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) Deletes a specified DB parameter group.deleteDBParameterGroup
(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DB parameter group.default CompletableFuture
<DeleteDbProxyResponse> deleteDBProxy
(Consumer<DeleteDbProxyRequest.Builder> deleteDbProxyRequest) Deletes an existing DB proxy.default CompletableFuture
<DeleteDbProxyResponse> deleteDBProxy
(DeleteDbProxyRequest deleteDbProxyRequest) Deletes an existing DB proxy.deleteDBProxyEndpoint
(Consumer<DeleteDbProxyEndpointRequest.Builder> deleteDbProxyEndpointRequest) Deletes aDBProxyEndpoint
.deleteDBProxyEndpoint
(DeleteDbProxyEndpointRequest deleteDbProxyEndpointRequest) Deletes aDBProxyEndpoint
.deleteDBSecurityGroup
(Consumer<DeleteDbSecurityGroupRequest.Builder> deleteDbSecurityGroupRequest) Deletes a DB security group.deleteDBSecurityGroup
(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest) Deletes a DB security group.deleteDBShardGroup
(Consumer<DeleteDbShardGroupRequest.Builder> deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.deleteDBShardGroup
(DeleteDbShardGroupRequest deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.deleteDBSnapshot
(Consumer<DeleteDbSnapshotRequest.Builder> deleteDbSnapshotRequest) Deletes a DB snapshot.deleteDBSnapshot
(DeleteDbSnapshotRequest deleteDbSnapshotRequest) Deletes a DB snapshot.deleteDBSubnetGroup
(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a DB subnet group.deleteDBSubnetGroup
(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.deleteGlobalCluster
(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database cluster.deleteGlobalCluster
(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database cluster.deleteIntegration
(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.deleteIntegration
(DeleteIntegrationRequest deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.deleteOptionGroup
(Consumer<DeleteOptionGroupRequest.Builder> deleteOptionGroupRequest) Deletes an existing option group.deleteOptionGroup
(DeleteOptionGroupRequest deleteOptionGroupRequest) Deletes an existing option group.deleteTenantDatabase
(Consumer<DeleteTenantDatabaseRequest.Builder> deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance.deleteTenantDatabase
(DeleteTenantDatabaseRequest deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance.deregisterDBProxyTargets
(Consumer<DeregisterDbProxyTargetsRequest.Builder> deregisterDbProxyTargetsRequest) Remove the association between one or moreDBProxyTarget
data structures and aDBProxyTargetGroup
.deregisterDBProxyTargets
(DeregisterDbProxyTargetsRequest deregisterDbProxyTargetsRequest) Remove the association between one or moreDBProxyTarget
data structures and aDBProxyTargetGroup
.Lists all of the attributes for a customer account.describeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Lists all of the attributes for a customer account.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the attributes for a customer account.describeBlueGreenDeployments
(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) Describes one or more blue/green deployments.describeBlueGreenDeployments
(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) Describes one or more blue/green deployments.describeBlueGreenDeploymentsPaginator
(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) This is a variant ofdescribeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation.describeBlueGreenDeploymentsPaginator
(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) This is a variant ofdescribeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation.Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.describeCertificates
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.describeCertificates
(DescribeCertificatesRequest describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.default DescribeCertificatesPublisher
This is a variant ofdescribeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.default DescribeCertificatesPublisher
describeCertificatesPaginator
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) This is a variant ofdescribeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.default DescribeCertificatesPublisher
describeCertificatesPaginator
(DescribeCertificatesRequest describeCertificatesRequest) This is a variant ofdescribeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.describeDBClusterAutomatedBackups
(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) Displays backups for both current and deleted DB clusters.describeDBClusterAutomatedBackups
(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) Displays backups for both current and deleted DB clusters.describeDBClusterAutomatedBackupsPaginator
(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) This is a variant ofdescribeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation.describeDBClusterAutomatedBackupsPaginator
(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) This is a variant ofdescribeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation.describeDBClusterBacktracks
(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) Returns information about backtracks for a DB cluster.describeDBClusterBacktracks
(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) Returns information about backtracks for a DB cluster.describeDBClusterBacktracksPaginator
(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) This is a variant ofdescribeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation.describeDBClusterBacktracksPaginator
(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) This is a variant ofdescribeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation.Returns information about endpoints for an Amazon Aurora DB cluster.describeDBClusterEndpoints
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Aurora DB cluster.describeDBClusterEndpoints
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Aurora DB cluster.This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.describeDBClusterEndpointsPaginator
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.describeDBClusterEndpointsPaginator
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameters
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParameters
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParametersPaginator
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation.describeDBClusterParametersPaginator
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation.Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.describeDBClusters
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.describeDBClusters
(DescribeDbClustersRequest describeDbClustersRequest) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.describeDBClusterSnapshotAttributes
(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.describeDBClusterSnapshotAttributes
(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.Returns information about DB cluster snapshots.describeDBClusterSnapshots
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.describeDBClusterSnapshots
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation.default DescribeDBClustersPublisher
This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersPublisher
describeDBClustersPaginator
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersPublisher
describeDBClustersPaginator
(DescribeDbClustersRequest describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.Describes the properties of specific versions of DB engines.describeDBEngineVersions
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.describeDBEngineVersions
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.describeDBEngineVersionsPaginator
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.describeDBEngineVersionsPaginator
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.Displays backups for both current and deleted instances.describeDBInstanceAutomatedBackups
(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) Displays backups for both current and deleted instances.describeDBInstanceAutomatedBackups
(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) Displays backups for both current and deleted instances.This is a variant ofdescribeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.describeDBInstanceAutomatedBackupsPaginator
(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) This is a variant ofdescribeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.describeDBInstanceAutomatedBackupsPaginator
(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) This is a variant ofdescribeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.Describes provisioned RDS instances.describeDBInstances
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Describes provisioned RDS instances.describeDBInstances
(DescribeDbInstancesRequest describeDbInstancesRequest) Describes provisioned RDS instances.default DescribeDBInstancesPublisher
This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesPublisher
describeDBInstancesPaginator
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesPublisher
describeDBInstancesPaginator
(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.describeDBLogFiles
(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.describeDBLogFiles
(DescribeDbLogFilesRequest describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.default DescribeDBLogFilesPublisher
describeDBLogFilesPaginator
(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) This is a variant ofdescribeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.default DescribeDBLogFilesPublisher
describeDBLogFilesPaginator
(DescribeDbLogFilesRequest describeDbLogFilesRequest) This is a variant ofdescribeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameters
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.describeDBParameters
(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersPublisher
describeDBParametersPaginator
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.default DescribeDBParametersPublisher
describeDBParametersPaginator
(DescribeDbParametersRequest describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.describeDBProxies
(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) Returns information about DB proxies.describeDBProxies
(DescribeDbProxiesRequest describeDbProxiesRequest) Returns information about DB proxies.default DescribeDBProxiesPublisher
describeDBProxiesPaginator
(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) This is a variant ofdescribeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.default DescribeDBProxiesPublisher
describeDBProxiesPaginator
(DescribeDbProxiesRequest describeDbProxiesRequest) This is a variant ofdescribeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.describeDBProxyEndpoints
(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.describeDBProxyEndpoints
(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.describeDBProxyEndpointsPaginator
(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) This is a variant ofdescribeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.describeDBProxyEndpointsPaginator
(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) This is a variant ofdescribeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.describeDBProxyTargetGroups
(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) Returns information about DB proxy target groups, represented byDBProxyTargetGroup
data structures.describeDBProxyTargetGroups
(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) Returns information about DB proxy target groups, represented byDBProxyTargetGroup
data structures.describeDBProxyTargetGroupsPaginator
(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) This is a variant ofdescribeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation.describeDBProxyTargetGroupsPaginator
(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) This is a variant ofdescribeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation.describeDBProxyTargets
(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) Returns information aboutDBProxyTarget
objects.describeDBProxyTargets
(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) Returns information aboutDBProxyTarget
objects.default DescribeDBProxyTargetsPublisher
describeDBProxyTargetsPaginator
(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) This is a variant ofdescribeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.default DescribeDBProxyTargetsPublisher
describeDBProxyTargetsPaginator
(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) This is a variant ofdescribeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.describeDBRecommendations
(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.describeDBRecommendations
(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.describeDBRecommendationsPaginator
(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) This is a variant ofdescribeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation.describeDBRecommendationsPaginator
(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) This is a variant ofdescribeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation.Returns a list ofDBSecurityGroup
descriptions.describeDBSecurityGroups
(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) Returns a list ofDBSecurityGroup
descriptions.describeDBSecurityGroups
(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) Returns a list ofDBSecurityGroup
descriptions.This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.describeDBSecurityGroupsPaginator
(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.describeDBSecurityGroupsPaginator
(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.describeDBShardGroups
(Consumer<DescribeDbShardGroupsRequest.Builder> describeDbShardGroupsRequest) Describes existing Aurora Limitless Database DB shard groups.describeDBShardGroups
(DescribeDbShardGroupsRequest describeDbShardGroupsRequest) Describes existing Aurora Limitless Database DB shard groups.describeDBSnapshotAttributes
(Consumer<DescribeDbSnapshotAttributesRequest.Builder> describeDbSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.describeDBSnapshotAttributes
(DescribeDbSnapshotAttributesRequest describeDbSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.Returns information about DB snapshots.describeDBSnapshots
(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) Returns information about DB snapshots.describeDBSnapshots
(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) Returns information about DB snapshots.default DescribeDBSnapshotsPublisher
This is a variant ofdescribeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.default DescribeDBSnapshotsPublisher
describeDBSnapshotsPaginator
(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) This is a variant ofdescribeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.default DescribeDBSnapshotsPublisher
describeDBSnapshotsPaginator
(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) This is a variant ofdescribeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.describeDBSnapshotTenantDatabases
(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) Describes the tenant databases that exist in a DB snapshot.describeDBSnapshotTenantDatabases
(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) Describes the tenant databases that exist in a DB snapshot.describeDBSnapshotTenantDatabasesPaginator
(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) This is a variant ofdescribeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation.describeDBSnapshotTenantDatabasesPaginator
(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) This is a variant ofdescribeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation.Returns a list of DBSubnetGroup descriptions.describeDBSubnetGroups
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.describeDBSubnetGroups
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsPublisher
This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsPublisher
describeDBSubnetGroupsPaginator
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsPublisher
describeDBSubnetGroupsPaginator
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.describeEngineDefaultClusterParameters
(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultClusterParameters
(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultParameters
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParameters
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParametersPaginator
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation.describeEngineDefaultParametersPaginator
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation.Displays a list of categories for all event source types, or, if specified, for a specified source type.describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default CompletableFuture
<DescribeEventsResponse> Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.default CompletableFuture
<DescribeEventsResponse> describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.default CompletableFuture
<DescribeEventsResponse> describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.default DescribeEventsPublisher
This is a variant ofdescribeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation.describeExportTasks
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3.describeExportTasks
(DescribeExportTasksRequest describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3.default DescribeExportTasksPublisher
describeExportTasksPaginator
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksPublisher
describeExportTasksPaginator
(DescribeExportTasksRequest describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.Returns information about Aurora global database clusters.describeGlobalClusters
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Aurora global database clusters.describeGlobalClusters
(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Aurora global database clusters.default DescribeGlobalClustersPublisher
This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersPublisher
describeGlobalClustersPaginator
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersPublisher
describeGlobalClustersPaginator
(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.describeIntegrations
(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.describeIntegrations
(DescribeIntegrationsRequest describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.default DescribeIntegrationsPublisher
describeIntegrationsPaginator
(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) This is a variant ofdescribeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.default DescribeIntegrationsPublisher
describeIntegrationsPaginator
(DescribeIntegrationsRequest describeIntegrationsRequest) This is a variant ofdescribeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.describeOptionGroupOptions
(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) Describes all available options for the specified engine.describeOptionGroupOptions
(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) Describes all available options for the specified engine.describeOptionGroupOptionsPaginator
(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) This is a variant ofdescribeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation.describeOptionGroupOptionsPaginator
(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) This is a variant ofdescribeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation.Describes the available option groups.describeOptionGroups
(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) Describes the available option groups.describeOptionGroups
(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.default DescribeOptionGroupsPublisher
This is a variant ofdescribeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.default DescribeOptionGroupsPublisher
describeOptionGroupsPaginator
(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) This is a variant ofdescribeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.default DescribeOptionGroupsPublisher
describeOptionGroupsPaginator
(DescribeOptionGroupsRequest describeOptionGroupsRequest) This is a variant ofdescribeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.describeOrderableDBInstanceOptions
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) Describes the orderable DB instance options for a specified DB engine.describeOrderableDBInstanceOptions
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Describes the orderable DB instance options for a specified DB engine.describeOrderableDBInstanceOptionsPaginator
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation.describeOrderableDBInstanceOptionsPaginator
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation.Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation.Returns information about reserved DB instances for this account, or about a specified reserved DB instance.describeReservedDBInstances
(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.describeReservedDBInstances
(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.Lists available reserved DB instance offerings.describeReservedDBInstancesOfferings
(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) Lists available reserved DB instance offerings.describeReservedDBInstancesOfferings
(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) Lists available reserved DB instance offerings.This is a variant ofdescribeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.describeReservedDBInstancesOfferingsPaginator
(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) This is a variant ofdescribeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.describeReservedDBInstancesOfferingsPaginator
(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) This is a variant ofdescribeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.This is a variant ofdescribeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.describeReservedDBInstancesPaginator
(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) This is a variant ofdescribeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.describeReservedDBInstancesPaginator
(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) This is a variant ofdescribeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.describeSourceRegions
(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.describeSourceRegions
(DescribeSourceRegionsRequest describeSourceRegionsRequest) Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.default DescribeSourceRegionsPublisher
This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.default DescribeSourceRegionsPublisher
describeSourceRegionsPaginator
(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.default DescribeSourceRegionsPublisher
describeSourceRegionsPaginator
(DescribeSourceRegionsRequest describeSourceRegionsRequest) This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.describeTenantDatabases
(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration.describeTenantDatabases
(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration.default DescribeTenantDatabasesPublisher
describeTenantDatabasesPaginator
(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) This is a variant ofdescribeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.default DescribeTenantDatabasesPublisher
describeTenantDatabasesPaginator
(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) This is a variant ofdescribeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.describeValidDBInstanceModifications
(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) You can callDescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance.describeValidDBInstanceModifications
(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) You can callDescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance.disableHttpEndpoint
(Consumer<DisableHttpEndpointRequest.Builder> disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster.disableHttpEndpoint
(DisableHttpEndpointRequest disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster.downloadDBLogFilePortion
(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.downloadDBLogFilePortion
(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.downloadDBLogFilePortionPaginator
(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) This is a variant ofdownloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.downloadDBLogFilePortionPaginator
(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) This is a variant ofdownloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.enableHttpEndpoint
(Consumer<EnableHttpEndpointRequest.Builder> enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster.enableHttpEndpoint
(EnableHttpEndpointRequest enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster.failoverDBCluster
(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.failoverDBCluster
(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.failoverGlobalCluster
(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database.failoverGlobalCluster
(FailoverGlobalClusterRequest failoverGlobalClusterRequest) Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.modifyActivityStream
(Consumer<ModifyActivityStreamRequest.Builder> modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked.modifyActivityStream
(ModifyActivityStreamRequest modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked.modifyCertificates
(Consumer<ModifyCertificatesRequest.Builder> modifyCertificatesRequest) Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.modifyCertificates
(ModifyCertificatesRequest modifyCertificatesRequest) Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.modifyCurrentDBClusterCapacity
(Consumer<ModifyCurrentDbClusterCapacityRequest.Builder> modifyCurrentDbClusterCapacityRequest) Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.modifyCurrentDBClusterCapacity
(ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest) Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.modifyCustomDBEngineVersion
(Consumer<ModifyCustomDbEngineVersionRequest.Builder> modifyCustomDbEngineVersionRequest) Modifies the status of a custom engine version (CEV).modifyCustomDBEngineVersion
(ModifyCustomDbEngineVersionRequest modifyCustomDbEngineVersionRequest) Modifies the status of a custom engine version (CEV).default CompletableFuture
<ModifyDbClusterResponse> modifyDBCluster
(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.default CompletableFuture
<ModifyDbClusterResponse> modifyDBCluster
(ModifyDbClusterRequest modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.modifyDBClusterEndpoint
(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Aurora DB cluster.modifyDBClusterEndpoint
(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Aurora DB cluster.modifyDBClusterParameterGroup
(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterParameterGroup
(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterSnapshotAttribute
(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.modifyDBClusterSnapshotAttribute
(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.modifyDBInstance
(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance.modifyDBInstance
(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance.modifyDBParameterGroup
(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.modifyDBParameterGroup
(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.default CompletableFuture
<ModifyDbProxyResponse> modifyDBProxy
(Consumer<ModifyDbProxyRequest.Builder> modifyDbProxyRequest) Changes the settings for an existing DB proxy.default CompletableFuture
<ModifyDbProxyResponse> modifyDBProxy
(ModifyDbProxyRequest modifyDbProxyRequest) Changes the settings for an existing DB proxy.modifyDBProxyEndpoint
(Consumer<ModifyDbProxyEndpointRequest.Builder> modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.modifyDBProxyEndpoint
(ModifyDbProxyEndpointRequest modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.modifyDBProxyTargetGroup
(Consumer<ModifyDbProxyTargetGroupRequest.Builder> modifyDbProxyTargetGroupRequest) Modifies the properties of aDBProxyTargetGroup
.modifyDBProxyTargetGroup
(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest) Modifies the properties of aDBProxyTargetGroup
.modifyDBRecommendation
(Consumer<ModifyDbRecommendationRequest.Builder> modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.modifyDBRecommendation
(ModifyDbRecommendationRequest modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.modifyDBShardGroup
(Consumer<ModifyDbShardGroupRequest.Builder> modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group.modifyDBShardGroup
(ModifyDbShardGroupRequest modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group.modifyDBSnapshot
(Consumer<ModifyDbSnapshotRequest.Builder> modifyDbSnapshotRequest) Updates a manual DB snapshot with a new engine version.modifyDBSnapshot
(ModifyDbSnapshotRequest modifyDbSnapshotRequest) Updates a manual DB snapshot with a new engine version.modifyDBSnapshotAttribute
(Consumer<ModifyDbSnapshotAttributeRequest.Builder> modifyDbSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.modifyDBSnapshotAttribute
(ModifyDbSnapshotAttributeRequest modifyDbSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.modifyDBSubnetGroup
(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.modifyDBSubnetGroup
(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription.modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription.modifyGlobalCluster
(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster.modifyGlobalCluster
(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster.modifyIntegration
(Consumer<ModifyIntegrationRequest.Builder> modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.modifyIntegration
(ModifyIntegrationRequest modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.modifyOptionGroup
(Consumer<ModifyOptionGroupRequest.Builder> modifyOptionGroupRequest) Modifies an existing option group.modifyOptionGroup
(ModifyOptionGroupRequest modifyOptionGroupRequest) Modifies an existing option group.modifyTenantDatabase
(Consumer<ModifyTenantDatabaseRequest.Builder> modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance.modifyTenantDatabase
(ModifyTenantDatabaseRequest modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance.promoteReadReplica
(Consumer<PromoteReadReplicaRequest.Builder> promoteReadReplicaRequest) Promotes a read replica DB instance to a standalone DB instance.promoteReadReplica
(PromoteReadReplicaRequest promoteReadReplicaRequest) Promotes a read replica DB instance to a standalone DB instance.promoteReadReplicaDBCluster
(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) Promotes a read replica DB cluster to a standalone DB cluster.promoteReadReplicaDBCluster
(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) Promotes a read replica DB cluster to a standalone DB cluster.purchaseReservedDBInstancesOffering
(Consumer<PurchaseReservedDbInstancesOfferingRequest.Builder> purchaseReservedDbInstancesOfferingRequest) Purchases a reserved DB instance offering.purchaseReservedDBInstancesOffering
(PurchaseReservedDbInstancesOfferingRequest purchaseReservedDbInstancesOfferingRequest) Purchases a reserved DB instance offering.default CompletableFuture
<RebootDbClusterResponse> rebootDBCluster
(Consumer<RebootDbClusterRequest.Builder> rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons.default CompletableFuture
<RebootDbClusterResponse> rebootDBCluster
(RebootDbClusterRequest rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons.rebootDBInstance
(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.rebootDBInstance
(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.rebootDBShardGroup
(Consumer<RebootDbShardGroupRequest.Builder> rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons.rebootDBShardGroup
(RebootDbShardGroupRequest rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons.registerDBProxyTargets
(Consumer<RegisterDbProxyTargetsRequest.Builder> registerDbProxyTargetsRequest) Associate one or moreDBProxyTarget
data structures with aDBProxyTargetGroup
.registerDBProxyTargets
(RegisterDbProxyTargetsRequest registerDbProxyTargetsRequest) Associate one or moreDBProxyTarget
data structures with aDBProxyTargetGroup
.removeFromGlobalCluster
(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster.removeFromGlobalCluster
(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster.removeRoleFromDBCluster
(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.removeRoleFromDBCluster
(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.removeRoleFromDBInstance
(Consumer<RemoveRoleFromDbInstanceRequest.Builder> removeRoleFromDbInstanceRequest) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.removeRoleFromDBInstance
(RemoveRoleFromDbInstanceRequest removeRoleFromDbInstanceRequest) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.removeSourceIdentifierFromSubscription
(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.removeSourceIdentifierFromSubscription
(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.resetDBClusterParameterGroup
(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBClusterParameterGroup
(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBParameterGroup
(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.resetDBParameterGroup
(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.restoreDBClusterFromS3
(Consumer<RestoreDbClusterFromS3Request.Builder> restoreDbClusterFromS3Request) Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.restoreDBClusterFromS3
(RestoreDbClusterFromS3Request restoreDbClusterFromS3Request) Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.restoreDBClusterFromSnapshot
(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterFromSnapshot
(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterToPointInTime
(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.restoreDBClusterToPointInTime
(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.restoreDBInstanceFromDBSnapshot
(Consumer<RestoreDbInstanceFromDbSnapshotRequest.Builder> restoreDbInstanceFromDbSnapshotRequest) Creates a new DB instance from a DB snapshot.restoreDBInstanceFromDBSnapshot
(RestoreDbInstanceFromDbSnapshotRequest restoreDbInstanceFromDbSnapshotRequest) Creates a new DB instance from a DB snapshot.restoreDBInstanceFromS3
(Consumer<RestoreDbInstanceFromS3Request.Builder> restoreDbInstanceFromS3Request) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.restoreDBInstanceFromS3
(RestoreDbInstanceFromS3Request restoreDbInstanceFromS3Request) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.restoreDBInstanceToPointInTime
(Consumer<RestoreDbInstanceToPointInTimeRequest.Builder> restoreDbInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time.restoreDBInstanceToPointInTime
(RestoreDbInstanceToPointInTimeRequest restoreDbInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time.revokeDBSecurityGroupIngress
(Consumer<RevokeDbSecurityGroupIngressRequest.Builder> revokeDbSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.revokeDBSecurityGroupIngress
(RevokeDbSecurityGroupIngressRequest revokeDbSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.default RdsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartActivityStream
(Consumer<StartActivityStreamRequest.Builder> startActivityStreamRequest) Starts a database activity stream to monitor activity on the database.startActivityStream
(StartActivityStreamRequest startActivityStreamRequest) Starts a database activity stream to monitor activity on the database.default CompletableFuture
<StartDbClusterResponse> startDBCluster
(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or theStopDBCluster
operation.default CompletableFuture
<StartDbClusterResponse> startDBCluster
(StartDbClusterRequest startDbClusterRequest) Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or theStopDBCluster
operation.default CompletableFuture
<StartDbInstanceResponse> startDBInstance
(Consumer<StartDbInstanceRequest.Builder> startDbInstanceRequest) Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or theStopDBInstance
operation.default CompletableFuture
<StartDbInstanceResponse> startDBInstance
(StartDbInstanceRequest startDbInstanceRequest) Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or theStopDBInstance
operation.startDBInstanceAutomatedBackupsReplication
(Consumer<StartDbInstanceAutomatedBackupsReplicationRequest.Builder> startDbInstanceAutomatedBackupsReplicationRequest) Enables replication of automated backups to a different Amazon Web Services Region.startDBInstanceAutomatedBackupsReplication
(StartDbInstanceAutomatedBackupsReplicationRequest startDbInstanceAutomatedBackupsReplicationRequest) Enables replication of automated backups to a different Amazon Web Services Region.default CompletableFuture
<StartExportTaskResponse> startExportTask
(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3.default CompletableFuture
<StartExportTaskResponse> startExportTask
(StartExportTaskRequest startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3.stopActivityStream
(Consumer<StopActivityStreamRequest.Builder> stopActivityStreamRequest) Stops a database activity stream that was started using the Amazon Web Services console, thestart-activity-stream
CLI command, or theStartActivityStream
operation.stopActivityStream
(StopActivityStreamRequest stopActivityStreamRequest) Stops a database activity stream that was started using the Amazon Web Services console, thestart-activity-stream
CLI command, or theStartActivityStream
operation.default CompletableFuture
<StopDbClusterResponse> stopDBCluster
(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Aurora DB cluster.default CompletableFuture
<StopDbClusterResponse> stopDBCluster
(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Aurora DB cluster.default CompletableFuture
<StopDbInstanceResponse> stopDBInstance
(Consumer<StopDbInstanceRequest.Builder> stopDbInstanceRequest) Stops an Amazon RDS DB instance.default CompletableFuture
<StopDbInstanceResponse> stopDBInstance
(StopDbInstanceRequest stopDbInstanceRequest) Stops an Amazon RDS DB instance.stopDBInstanceAutomatedBackupsReplication
(Consumer<StopDbInstanceAutomatedBackupsReplicationRequest.Builder> stopDbInstanceAutomatedBackupsReplicationRequest) Stops automated backup replication for a DB instance.stopDBInstanceAutomatedBackupsReplication
(StopDbInstanceAutomatedBackupsReplicationRequest stopDbInstanceAutomatedBackupsReplicationRequest) Stops automated backup replication for a DB instance.switchoverBlueGreenDeployment
(Consumer<SwitchoverBlueGreenDeploymentRequest.Builder> switchoverBlueGreenDeploymentRequest) Switches over a blue/green deployment.switchoverBlueGreenDeployment
(SwitchoverBlueGreenDeploymentRequest switchoverBlueGreenDeploymentRequest) Switches over a blue/green deployment.switchoverGlobalCluster
(Consumer<SwitchoverGlobalClusterRequest.Builder> switchoverGlobalClusterRequest) Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.switchoverGlobalCluster
(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.switchoverReadReplica
(Consumer<SwitchoverReadReplicaRequest.Builder> switchoverReadReplicaRequest) Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.switchoverReadReplica
(SwitchoverReadReplicaRequest switchoverReadReplicaRequest) Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.default RdsUtilities
Creates an instance ofRdsUtilities
object with the configuration set on this client.default RdsAsyncWaiter
waiter()
Create an instance ofRdsAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
utilities
Creates an instance ofRdsUtilities
object with the configuration set on this client. -
addRoleToDBCluster
default CompletableFuture<AddRoleToDbClusterResponse> addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.
- Parameters:
addRoleToDbClusterRequest
-- Returns:
- A Java Future containing the result of the AddRoleToDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterRoleAlreadyExistsException The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterRoleQuotaExceededException You have exceeded the maximum number of IAM roles that can be associated with the specified DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
addRoleToDBCluster
default CompletableFuture<AddRoleToDbClusterResponse> addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.
This is a convenience which creates an instance of the
AddRoleToDbClusterRequest.Builder
avoiding the need to create one manually viaAddRoleToDbClusterRequest.builder()
- Parameters:
addRoleToDbClusterRequest
- AConsumer
that will call methods onAddRoleToDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddRoleToDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterRoleAlreadyExistsException The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterRoleQuotaExceededException You have exceeded the maximum number of IAM roles that can be associated with the specified DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
addRoleToDBInstance
default CompletableFuture<AddRoleToDbInstanceResponse> addRoleToDBInstance(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest) Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be
available
.This command doesn't apply to RDS Custom.
- Parameters:
addRoleToDbInstanceRequest
-- Returns:
- A Java Future containing the result of the AddRoleToDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbInstanceRoleAlreadyExistsException The specified
RoleArn
orFeatureName
value is already associated with the DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceRoleQuotaExceededException You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
addRoleToDBInstance
default CompletableFuture<AddRoleToDbInstanceResponse> addRoleToDBInstance(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest) Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be
available
.This command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
AddRoleToDbInstanceRequest.Builder
avoiding the need to create one manually viaAddRoleToDbInstanceRequest.builder()
- Parameters:
addRoleToDbInstanceRequest
- AConsumer
that will call methods onAddRoleToDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddRoleToDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbInstanceRoleAlreadyExistsException The specified
RoleArn
orFeatureName
value is already associated with the DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceRoleQuotaExceededException You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
addSourceIdentifierToSubscription
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addSourceIdentifierToSubscription
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.
This is a convenience which creates an instance of the
AddSourceIdentifierToSubscriptionRequest.Builder
avoiding the need to create one manually viaAddSourceIdentifierToSubscriptionRequest.builder()
- Parameters:
addSourceIdentifierToSubscriptionRequest
- AConsumer
that will call methods onAddSourceIdentifierToSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
- Parameters:
addTagsToResourceRequest
-- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builder
avoiding the need to create one manually viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
applyPendingMaintenanceAction
default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
applyPendingMaintenanceAction
default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).
This is a convenience which creates an instance of the
ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()
- Parameters:
applyPendingMaintenanceActionRequest
- AConsumer
that will call methods onApplyPendingMaintenanceActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
authorizeDBSecurityGroupIngress
default CompletableFuture<AuthorizeDbSecurityGroupIngressResponse> authorizeDBSecurityGroupIngress(AuthorizeDbSecurityGroupIngressRequest authorizeDbSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Parameters:
authorizeDbSecurityGroupIngressRequest
-- Returns:
- A Java Future containing the result of the AuthorizeDBSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- AuthorizationAlreadyExistsException The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
- AuthorizationQuotaExceededException The DB security group authorization quota has been reached.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
authorizeDBSecurityGroupIngress
default CompletableFuture<AuthorizeDbSecurityGroupIngressResponse> authorizeDBSecurityGroupIngress(Consumer<AuthorizeDbSecurityGroupIngressRequest.Builder> authorizeDbSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
AuthorizeDbSecurityGroupIngressRequest.Builder
avoiding the need to create one manually viaAuthorizeDbSecurityGroupIngressRequest.builder()
- Parameters:
authorizeDbSecurityGroupIngressRequest
- AConsumer
that will call methods onAuthorizeDbSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AuthorizeDBSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- AuthorizationAlreadyExistsException The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
- AuthorizationQuotaExceededException The DB security group authorization quota has been reached.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
backtrackDBCluster
default CompletableFuture<BacktrackDbClusterResponse> backtrackDBCluster(BacktrackDbClusterRequest backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
- Parameters:
backtrackDbClusterRequest
-- Returns:
- A Java Future containing the result of the BacktrackDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
backtrackDBCluster
default CompletableFuture<BacktrackDbClusterResponse> backtrackDBCluster(Consumer<BacktrackDbClusterRequest.Builder> backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
This is a convenience which creates an instance of the
BacktrackDbClusterRequest.Builder
avoiding the need to create one manually viaBacktrackDbClusterRequest.builder()
- Parameters:
backtrackDbClusterRequest
- AConsumer
that will call methods onBacktrackDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BacktrackDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
cancelExportTask
default CompletableFuture<CancelExportTaskResponse> cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
- Parameters:
cancelExportTaskRequest
-- Returns:
- A Java Future containing the result of the CancelExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't exist.
- InvalidExportTaskStateException You can't cancel an export task that has completed.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelExportTask
default CompletableFuture<CancelExportTaskResponse> cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest) Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
This is a convenience which creates an instance of the
CancelExportTaskRequest.Builder
avoiding the need to create one manually viaCancelExportTaskRequest.builder()
- Parameters:
cancelExportTaskRequest
- AConsumer
that will call methods onCancelExportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't exist.
- InvalidExportTaskStateException You can't cancel an export task that has completed.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyDBClusterParameterGroup
default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.
You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
- Parameters:
copyDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
copyDBClusterParameterGroup
default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.
You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
This is a convenience which creates an instance of the
CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCopyDbClusterParameterGroupRequest.builder()
- Parameters:
copyDbClusterParameterGroupRequest
- AConsumer
that will call methods onCopyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
copyDBClusterSnapshot
default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the
CopyDBClusterSnapshot
operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:-
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
copyDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CopyDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
copyDBClusterSnapshot
default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the
CopyDBClusterSnapshot
operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:-
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CopyDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCopyDbClusterSnapshotRequest.builder()
- Parameters:
copyDbClusterSnapshotRequest
- AConsumer
that will call methods onCopyDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
copyDBParameterGroup
default CompletableFuture<CopyDbParameterGroupResponse> copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.
You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
- Parameters:
copyDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CopyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbParameterGroupAlreadyExistsException A DB parameter group with the same name exists.
- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
copyDBParameterGroup
default CompletableFuture<CopyDbParameterGroupResponse> copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) Copies the specified DB parameter group.
You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
This is a convenience which creates an instance of the
CopyDbParameterGroupRequest.Builder
avoiding the need to create one manually viaCopyDbParameterGroupRequest.builder()
- Parameters:
copyDbParameterGroupRequest
- AConsumer
that will call methods onCopyDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbParameterGroupAlreadyExistsException A DB parameter group with the same name exists.
- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
copyDBSnapshot
default CompletableFuture<CopyDbSnapshotResponse> copyDBSnapshot(CopyDbSnapshotRequest copyDbSnapshotRequest) Copies the specified DB snapshot. The source DB snapshot must be in the
available
state.You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the
CopyDBSnapshot
operation is the destination Amazon Web Services Region for the DB snapshot copy.This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
- Parameters:
copyDbSnapshotRequest
-- Returns:
- A Java Future containing the result of the CopyDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- CustomAvailabilityZoneNotFoundException
CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotAlreadyExistsException
- See Also:
-
copyDBSnapshot
default CompletableFuture<CopyDbSnapshotResponse> copyDBSnapshot(Consumer<CopyDbSnapshotRequest.Builder> copyDbSnapshotRequest) Copies the specified DB snapshot. The source DB snapshot must be in the
available
state.You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the
CopyDBSnapshot
operation is the destination Amazon Web Services Region for the DB snapshot copy.This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CopyDbSnapshotRequest.Builder
avoiding the need to create one manually viaCopyDbSnapshotRequest.builder()
- Parameters:
copyDbSnapshotRequest
- AConsumer
that will call methods onCopyDbSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- CustomAvailabilityZoneNotFoundException
CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotAlreadyExistsException
- See Also:
-
copyOptionGroup
default CompletableFuture<CopyOptionGroupResponse> copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest) Copies the specified option group.
- Parameters:
copyOptionGroupRequest
-- Returns:
- A Java Future containing the result of the CopyOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupAlreadyExistsException The option group you are trying to create already exists.
- OptionGroupNotFoundException The specified option group could not be found.
- OptionGroupQuotaExceededException The quota of 20 option groups was exceeded for this Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyOptionGroup
default CompletableFuture<CopyOptionGroupResponse> copyOptionGroup(Consumer<CopyOptionGroupRequest.Builder> copyOptionGroupRequest) Copies the specified option group.
This is a convenience which creates an instance of the
CopyOptionGroupRequest.Builder
avoiding the need to create one manually viaCopyOptionGroupRequest.builder()
- Parameters:
copyOptionGroupRequest
- AConsumer
that will call methods onCopyOptionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupAlreadyExistsException The option group you are trying to create already exists.
- OptionGroupNotFoundException The specified option group could not be found.
- OptionGroupQuotaExceededException The quota of 20 option groups was exceeded for this Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBlueGreenDeployment
default CompletableFuture<CreateBlueGreenDeploymentResponse> createBlueGreenDeployment(CreateBlueGreenDeploymentRequest createBlueGreenDeploymentRequest) Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Parameters:
createBlueGreenDeploymentRequest
-- Returns:
- A Java Future containing the result of the CreateBlueGreenDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - SourceDatabaseNotSupportedException The source DB instance isn't supported for a blue/green deployment.
- SourceClusterNotSupportedException The source DB cluster isn't supported for a blue/green deployment.
- BlueGreenDeploymentAlreadyExistsException A blue/green deployment with the specified name already exists.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
createBlueGreenDeployment
default CompletableFuture<CreateBlueGreenDeploymentResponse> createBlueGreenDeployment(Consumer<CreateBlueGreenDeploymentRequest.Builder> createBlueGreenDeploymentRequest) Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
CreateBlueGreenDeploymentRequest.Builder
avoiding the need to create one manually viaCreateBlueGreenDeploymentRequest.builder()
- Parameters:
createBlueGreenDeploymentRequest
- AConsumer
that will call methods onCreateBlueGreenDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBlueGreenDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - SourceDatabaseNotSupportedException The source DB instance isn't supported for a blue/green deployment.
- SourceClusterNotSupportedException The source DB cluster isn't supported for a blue/green deployment.
- BlueGreenDeploymentAlreadyExistsException A blue/green deployment with the specified name already exists.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
createCustomDBEngineVersion
default CompletableFuture<CreateCustomDbEngineVersionResponse> createCustomDBEngineVersion(CreateCustomDbEngineVersionRequest createCustomDbEngineVersionRequest) Creates a custom DB engine version (CEV).
- Parameters:
createCustomDbEngineVersionRequest
-- Returns:
- A Java Future containing the result of the CreateCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionAlreadyExistsException A CEV with the specified name already exists.
- CustomDbEngineVersionQuotaExceededException You have exceeded your CEV quota.
- Ec2ImagePropertiesNotSupportedException The AMI configuration prerequisite has not been met.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- CreateCustomDbEngineVersionException An error occurred while trying to create the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomDBEngineVersion
default CompletableFuture<CreateCustomDbEngineVersionResponse> createCustomDBEngineVersion(Consumer<CreateCustomDbEngineVersionRequest.Builder> createCustomDbEngineVersionRequest) Creates a custom DB engine version (CEV).
This is a convenience which creates an instance of the
CreateCustomDbEngineVersionRequest.Builder
avoiding the need to create one manually viaCreateCustomDbEngineVersionRequest.builder()
- Parameters:
createCustomDbEngineVersionRequest
- AConsumer
that will call methods onCreateCustomDbEngineVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionAlreadyExistsException A CEV with the specified name already exists.
- CustomDbEngineVersionQuotaExceededException You have exceeded your CEV quota.
- Ec2ImagePropertiesNotSupportedException The AMI configuration prerequisite has not been met.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- CreateCustomDbEngineVersionException An error occurred while trying to create the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBCluster
default CompletableFuture<CreateDbClusterResponse> createDBCluster(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the
ReplicationSourceIdentifier
parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.You can also use the
ReplicationSourceIdentifier
parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.- Parameters:
createDbClusterRequest
-- Returns:
- A Java Future containing the result of the CreateDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InsufficientStorageClusterCapacityException There is insufficient 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 user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSubnetGroupException The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBCluster
default CompletableFuture<CreateDbClusterResponse> createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the
ReplicationSourceIdentifier
parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.You can also use the
ReplicationSourceIdentifier
parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CreateDbClusterRequest.Builder
avoiding the need to create one manually viaCreateDbClusterRequest.builder()
- Parameters:
createDbClusterRequest
- AConsumer
that will call methods onCreateDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InsufficientStorageClusterCapacityException There is insufficient 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 user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSubnetGroupException The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterEndpoint
default CompletableFuture<CreateDbClusterEndpointResponse> createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
- Parameters:
createDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterEndpointQuotaExceededException The cluster already has the maximum number of custom endpoints.
- DbClusterEndpointAlreadyExistsException The specified custom endpoint can't be created because it already exists.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterEndpoint
default CompletableFuture<CreateDbClusterEndpointResponse> createDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
This is a convenience which creates an instance of the
CreateDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaCreateDbClusterEndpointRequest.builder()
- Parameters:
createDbClusterEndpointRequest
- AConsumer
that will call methods onCreateDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterEndpointQuotaExceededException The cluster already has the maximum number of custom endpoints.
- DbClusterEndpointAlreadyExistsException The specified custom endpoint can't be created because it already exists.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterParameterGroup
default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using
ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster usingModifyDBCluster
.When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or theDescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
createDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterParameterGroup
default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using
ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster usingModifyDBCluster
.When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or theDescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbClusterParameterGroupRequest.builder()
- Parameters:
createDbClusterParameterGroupRequest
- AConsumer
that will call methods onCreateDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterSnapshot
default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
createDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBClusterSnapshot
default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CreateDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCreateDbClusterSnapshotRequest.builder()
- Parameters:
createDbClusterSnapshotRequest
- AConsumer
that will call methods onCreateDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBInstance
default CompletableFuture<CreateDbInstanceResponse> createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
- Parameters:
createDbInstanceRequest
-- Returns:
- A Java Future containing the result of the CreateDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBInstance
default CompletableFuture<CreateDbInstanceResponse> createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builder
avoiding the need to create one manually viaCreateDbInstanceRequest.builder()
- Parameters:
createDbInstanceRequest
- AConsumer
that will call methods onCreateDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBInstanceReadReplica
default CompletableFuture<CreateDbInstanceReadReplicaResponse> createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest) Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the
CreateDBInstance
operation.All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
- Parameters:
createDbInstanceReadReplicaRequest
-- Returns:
- A Java Future containing the result of the CreateDBInstanceReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbSubnetGroupNotAllowedException The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
- InvalidDbSubnetGroupException The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBInstanceReadReplica
default CompletableFuture<CreateDbInstanceReadReplicaResponse> createDBInstanceReadReplica(Consumer<CreateDbInstanceReadReplicaRequest.Builder> createDbInstanceReadReplicaRequest) Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the
CreateDBInstance
operation.All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
This is a convenience which creates an instance of the
CreateDbInstanceReadReplicaRequest.Builder
avoiding the need to create one manually viaCreateDbInstanceReadReplicaRequest.builder()
- Parameters:
createDbInstanceReadReplicaRequest
- AConsumer
that will call methods onCreateDbInstanceReadReplicaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBInstanceReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbSubnetGroupNotAllowedException The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
- InvalidDbSubnetGroupException The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using
ModifyDBParameterGroup
. Once you've created a DB parameter group, you need to associate it with your DB instance usingModifyDBInstance
. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.This command doesn't apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
createDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using
ModifyDBParameterGroup
. Once you've created a DB parameter group, you need to associate it with your DB instance usingModifyDBInstance
. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.This command doesn't apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
This is a convenience which creates an instance of the
CreateDbParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbParameterGroupRequest.builder()
- Parameters:
createDbParameterGroupRequest
- AConsumer
that will call methods onCreateDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB parameter groups.
- DbParameterGroupAlreadyExistsException A DB parameter group with the same name 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBProxy
default CompletableFuture<CreateDbProxyResponse> createDBProxy(CreateDbProxyRequest createDbProxyRequest) Creates a new DB proxy.
- Parameters:
createDbProxyRequest
-- Returns:
- A Java Future containing the result of the CreateDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbProxyAlreadyExistsException The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyQuotaExceededException Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBProxy
default CompletableFuture<CreateDbProxyResponse> createDBProxy(Consumer<CreateDbProxyRequest.Builder> createDbProxyRequest) Creates a new DB proxy.
This is a convenience which creates an instance of the
CreateDbProxyRequest.Builder
avoiding the need to create one manually viaCreateDbProxyRequest.builder()
- Parameters:
createDbProxyRequest
- AConsumer
that will call methods onCreateDbProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbProxyAlreadyExistsException The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyQuotaExceededException Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBProxyEndpoint
default CompletableFuture<CreateDbProxyEndpointResponse> createDBProxyEndpoint(CreateDbProxyEndpointRequest createDbProxyEndpointRequest) Creates a
DBProxyEndpoint
. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.- Parameters:
createDbProxyEndpointRequest
-- Returns:
- A Java Future containing the result of the CreateDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointAlreadyExistsException The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointQuotaExceededException The DB proxy already has the maximum number of endpoints.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBProxyEndpoint
default CompletableFuture<CreateDbProxyEndpointResponse> createDBProxyEndpoint(Consumer<CreateDbProxyEndpointRequest.Builder> createDbProxyEndpointRequest) Creates a
DBProxyEndpoint
. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
This is a convenience which creates an instance of the
CreateDbProxyEndpointRequest.Builder
avoiding the need to create one manually viaCreateDbProxyEndpointRequest.builder()
- Parameters:
createDbProxyEndpointRequest
- AConsumer
that will call methods onCreateDbProxyEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointAlreadyExistsException The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointQuotaExceededException The DB proxy already has the maximum number of endpoints.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBSecurityGroup
default CompletableFuture<CreateDbSecurityGroupResponse> createDBSecurityGroup(CreateDbSecurityGroupRequest createDbSecurityGroupRequest) Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Parameters:
createDbSecurityGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupAlreadyExistsException A DB security group with the name specified in
DBSecurityGroupName
already exists. - DbSecurityGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB security groups.
- DbSecurityGroupNotSupportedException A DB security group isn't allowed for this action.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupAlreadyExistsException A DB security group with the name specified in
- See Also:
-
createDBSecurityGroup
default CompletableFuture<CreateDbSecurityGroupResponse> createDBSecurityGroup(Consumer<CreateDbSecurityGroupRequest.Builder> createDbSecurityGroupRequest) Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
CreateDbSecurityGroupRequest.Builder
avoiding the need to create one manually viaCreateDbSecurityGroupRequest.builder()
- Parameters:
createDbSecurityGroupRequest
- AConsumer
that will call methods onCreateDbSecurityGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupAlreadyExistsException A DB security group with the name specified in
DBSecurityGroupName
already exists. - DbSecurityGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB security groups.
- DbSecurityGroupNotSupportedException A DB security group isn't allowed for this action.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupAlreadyExistsException A DB security group with the name specified in
- See Also:
-
createDBShardGroup
default CompletableFuture<CreateDbShardGroupResponse> createDBShardGroup(CreateDbShardGroupRequest createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
- Parameters:
createDbShardGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupAlreadyExistsException The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - MaxDbShardGroupLimitReachedException The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidMaxAcuException The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
- UnsupportedDbEngineVersionException The specified DB engine version isn't supported for Aurora Limitless Database.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBShardGroup
default CompletableFuture<CreateDbShardGroupResponse> createDBShardGroup(Consumer<CreateDbShardGroupRequest.Builder> createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
This is a convenience which creates an instance of the
CreateDbShardGroupRequest.Builder
avoiding the need to create one manually viaCreateDbShardGroupRequest.builder()
- Parameters:
createDbShardGroupRequest
- AConsumer
that will call methods onCreateDbShardGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupAlreadyExistsException The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - MaxDbShardGroupLimitReachedException The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidMaxAcuException The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
- UnsupportedDbEngineVersionException The specified DB engine version isn't supported for Aurora Limitless Database.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDBSnapshot
default CompletableFuture<CreateDbSnapshotResponse> createDBSnapshot(CreateDbSnapshotRequest createDbSnapshotRequest) Creates a snapshot of a DB instance. The source DB instance must be in the
available
orstorage-optimization
state.- Parameters:
createDbSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotAlreadyExistsException
- See Also:
-
createDBSnapshot
default CompletableFuture<CreateDbSnapshotResponse> createDBSnapshot(Consumer<CreateDbSnapshotRequest.Builder> createDbSnapshotRequest) Creates a snapshot of a DB instance. The source DB instance must be in the
available
orstorage-optimization
state.
This is a convenience which creates an instance of the
CreateDbSnapshotRequest.Builder
avoiding the need to create one manually viaCreateDbSnapshotRequest.builder()
- Parameters:
createDbSnapshotRequest
- AConsumer
that will call methods onCreateDbSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotAlreadyExistsException
- See Also:
-
createDBSubnetGroup
default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
- Parameters:
createDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupAlreadyExistsException
DBSubnetGroupName
is already used by an existing DB subnet group. - DbSubnetGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB subnet groups.
- DbSubnetQuotaExceededException The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupAlreadyExistsException
- See Also:
-
createDBSubnetGroup
default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
This is a convenience which creates an instance of the
CreateDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()
- Parameters:
createDbSubnetGroupRequest
- AConsumer
that will call methods onCreateDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupAlreadyExistsException
DBSubnetGroupName
is already used by an existing DB subnet group. - DbSubnetGroupQuotaExceededException The request would result in the user exceeding the allowed number of DB subnet groups.
- DbSubnetQuotaExceededException The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupAlreadyExistsException
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (
SourceType
) that you want to be notified of and provide a list of RDS sources (SourceIds
) that triggers the events. You can also provide a list of event categories (EventCategories
) for events that you want to be notified of. For example, you can specifySourceType
=db-instance
,SourceIds
=mydbinstance1
,mydbinstance2
andEventCategories
=Availability
,Backup
.If you specify both the
SourceType
andSourceIds
, such asSourceType
=db-instance
andSourceIds
=myDBInstance1
, you are notified of all thedb-instance
events for the specified source. If you specify aSourceType
but do not specifySourceIds
, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or theSourceIds
, you are notified of events generated from all RDS sources belonging to your customer account.For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
- Parameters:
createEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have reached the maximum number of event subscriptions.
- SubscriptionAlreadyExistException The supplied subscription name already exists.
- SnsInvalidTopicException SNS has responded that there is a problem with the SNS topic specified.
- SnsNoAuthorizationException You do not have permission to publish to the SNS topic ARN.
- SnsTopicArnNotFoundException The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundException The supplied 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventSubscription
default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (
SourceType
) that you want to be notified of and provide a list of RDS sources (SourceIds
) that triggers the events. You can also provide a list of event categories (EventCategories
) for events that you want to be notified of. For example, you can specifySourceType
=db-instance
,SourceIds
=mydbinstance1
,mydbinstance2
andEventCategories
=Availability
,Backup
.If you specify both the
SourceType
andSourceIds
, such asSourceType
=db-instance
andSourceIds
=myDBInstance1
, you are notified of all thedb-instance
events for the specified source. If you specify aSourceType
but do not specifySourceIds
, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or theSourceIds
, you are notified of events generated from all RDS sources belonging to your customer account.For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
CreateEventSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have reached the maximum number of event subscriptions.
- SubscriptionAlreadyExistException The supplied subscription name already exists.
- SnsInvalidTopicException SNS has responded that there is a problem with the SNS topic specified.
- SnsNoAuthorizationException You do not have permission to publish to the SNS topic ARN.
- SnsTopicArnNotFoundException The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundException The supplied 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGlobalCluster
default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
- Parameters:
createGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the CreateGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterAlreadyExistsException The
GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique name) to create a new global database cluster. - GlobalClusterQuotaExceededException The number of global database clusters for this account is already at the maximum allowed.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterAlreadyExistsException The
- See Also:
-
createGlobalCluster
default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
This is a convenience which creates an instance of the
CreateGlobalClusterRequest.Builder
avoiding the need to create one manually viaCreateGlobalClusterRequest.builder()
- Parameters:
createGlobalClusterRequest
- AConsumer
that will call methods onCreateGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterAlreadyExistsException The
GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique name) to create a new global database cluster. - GlobalClusterQuotaExceededException The number of global database clusters for this account is already at the maximum allowed.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterAlreadyExistsException The
- See Also:
-
createIntegration
default CompletableFuture<CreateIntegrationResponse> createIntegration(CreateIntegrationRequest createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.
- Parameters:
createIntegrationRequest
-- Returns:
- A Java Future containing the result of the CreateIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - IntegrationAlreadyExistsException The integration you are trying to create already exists.
- IntegrationQuotaExceededException You can't crate any more zero-ETL integrations because the quota has been reached.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
createIntegration
default CompletableFuture<CreateIntegrationResponse> createIntegration(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.
This is a convenience which creates an instance of the
CreateIntegrationRequest.Builder
avoiding the need to create one manually viaCreateIntegrationRequest.builder()
- Parameters:
createIntegrationRequest
- AConsumer
that will call methods onCreateIntegrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - IntegrationAlreadyExistsException The integration you are trying to create already exists.
- IntegrationQuotaExceededException You can't crate any more zero-ETL integrations because the quota has been reached.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
createOptionGroup
default CompletableFuture<CreateOptionGroupResponse> createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest) Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
- Parameters:
createOptionGroupRequest
-- Returns:
- A Java Future containing the result of the CreateOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupAlreadyExistsException The option group you are trying to create already exists.
- OptionGroupQuotaExceededException The quota of 20 option groups was exceeded for this Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOptionGroup
default CompletableFuture<CreateOptionGroupResponse> createOptionGroup(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest) Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
CreateOptionGroupRequest.Builder
avoiding the need to create one manually viaCreateOptionGroupRequest.builder()
- Parameters:
createOptionGroupRequest
- AConsumer
that will call methods onCreateOptionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupAlreadyExistsException The option group you are trying to create already exists.
- OptionGroupQuotaExceededException The quota of 20 option groups was exceeded for this Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTenantDatabase
default CompletableFuture<CreateTenantDatabaseResponse> createTenantDatabase(CreateTenantDatabaseRequest createTenantDatabaseRequest) Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
- Parameters:
createTenantDatabaseRequest
-- Returns:
- A Java Future containing the result of the CreateTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- TenantDatabaseAlreadyExistsException You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
createTenantDatabase
default CompletableFuture<CreateTenantDatabaseResponse> createTenantDatabase(Consumer<CreateTenantDatabaseRequest.Builder> createTenantDatabaseRequest) Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
This is a convenience which creates an instance of the
CreateTenantDatabaseRequest.Builder
avoiding the need to create one manually viaCreateTenantDatabaseRequest.builder()
- Parameters:
createTenantDatabaseRequest
- AConsumer
that will call methods onCreateTenantDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- TenantDatabaseAlreadyExistsException You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
deleteBlueGreenDeployment
default CompletableFuture<DeleteBlueGreenDeploymentResponse> deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest deleteBlueGreenDeploymentRequest) Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Parameters:
deleteBlueGreenDeploymentRequest
-- Returns:
- A Java Future containing the result of the DeleteBlueGreenDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - InvalidBlueGreenDeploymentStateException The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
deleteBlueGreenDeployment
default CompletableFuture<DeleteBlueGreenDeploymentResponse> deleteBlueGreenDeployment(Consumer<DeleteBlueGreenDeploymentRequest.Builder> deleteBlueGreenDeploymentRequest) Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
DeleteBlueGreenDeploymentRequest.Builder
avoiding the need to create one manually viaDeleteBlueGreenDeploymentRequest.builder()
- Parameters:
deleteBlueGreenDeploymentRequest
- AConsumer
that will call methods onDeleteBlueGreenDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBlueGreenDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - InvalidBlueGreenDeploymentStateException The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
deleteCustomDBEngineVersion
default CompletableFuture<DeleteCustomDbEngineVersionResponse> deleteCustomDBEngineVersion(DeleteCustomDbEngineVersionRequest deleteCustomDbEngineVersionRequest) Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
-
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
-
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for theDeleteCustomDbEngineVersion
event.For more information, see Deleting a CEV in the Amazon RDS User Guide.
- Parameters:
deleteCustomDbEngineVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionNotFoundException The specified CEV was not found.
- InvalidCustomDbEngineVersionStateException You can't delete the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteCustomDBEngineVersion
default CompletableFuture<DeleteCustomDbEngineVersionResponse> deleteCustomDBEngineVersion(Consumer<DeleteCustomDbEngineVersionRequest.Builder> deleteCustomDbEngineVersionRequest) Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
-
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
-
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for theDeleteCustomDbEngineVersion
event.For more information, see Deleting a CEV in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DeleteCustomDbEngineVersionRequest.Builder
avoiding the need to create one manually viaDeleteCustomDbEngineVersionRequest.builder()
- Parameters:
deleteCustomDbEngineVersionRequest
- AConsumer
that will call methods onDeleteCustomDbEngineVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionNotFoundException The specified CEV was not found.
- InvalidCustomDbEngineVersionStateException You can't delete the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteDBCluster
default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
deleteDbClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- DbClusterAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
deleteDBCluster
default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DeleteDbClusterRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterRequest.builder()
- Parameters:
deleteDbClusterRequest
- AConsumer
that will call methods onDeleteDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterSnapshotAlreadyExistsException The user already has a DB cluster snapshot with the given identifier.
- SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- DbClusterAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
deleteDBClusterAutomatedBackup
default CompletableFuture<DeleteDbClusterAutomatedBackupResponse> deleteDBClusterAutomatedBackup(DeleteDbClusterAutomatedBackupRequest deleteDbClusterAutomatedBackupRequest) Deletes automated backups using the
DbClusterResourceId
value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.- Parameters:
deleteDbClusterAutomatedBackupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterAutomatedBackup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterAutomatedBackupStateException The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterAutomatedBackup
default CompletableFuture<DeleteDbClusterAutomatedBackupResponse> deleteDBClusterAutomatedBackup(Consumer<DeleteDbClusterAutomatedBackupRequest.Builder> deleteDbClusterAutomatedBackupRequest) Deletes automated backups using the
DbClusterResourceId
value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
This is a convenience which creates an instance of the
DeleteDbClusterAutomatedBackupRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterAutomatedBackupRequest.builder()
- Parameters:
deleteDbClusterAutomatedBackupRequest
- AConsumer
that will call methods onDeleteDbClusterAutomatedBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterAutomatedBackup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterAutomatedBackupStateException The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterEndpoint
default CompletableFuture<DeleteDbClusterEndpointResponse> deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Parameters:
deleteDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterEndpointStateException The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterEndpoint
default CompletableFuture<DeleteDbClusterEndpointResponse> deleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
DeleteDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterEndpointRequest.builder()
- Parameters:
deleteDbClusterEndpointRequest
- AConsumer
that will call methods onDeleteDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterEndpointStateException The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterParameterGroup
default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
deleteDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterParameterGroup
default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DeleteDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterParameterGroupRequest.builder()
- Parameters:
deleteDbClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterSnapshot
default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
available
state to be deleted.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
deleteDbClusterSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBClusterSnapshot
default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the
available
state to be deleted.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DeleteDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterSnapshotRequest.builder()
- Parameters:
deleteDbClusterSnapshotRequest
- AConsumer
that will call methods onDeleteDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBClusterSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is
deleting
until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, useDescribeDBInstance
.When a DB instance is in a failure state and has a status of
failed
,incompatible-restore
, orincompatible-network
, you can only delete it when you skip creation of the final snapshot with theSkipFinalSnapshot
parameter.If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
-
The DB cluster is a read replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the
PromoteReadReplicaDBCluster
operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use theDeleteDBInstance
operation to delete the final instance in the DB cluster.For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
- Parameters:
deleteDbInstanceRequest
-- Returns:
- A Java Future containing the result of the DeleteDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbInstanceAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
-
deleteDBInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is
deleting
until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, useDescribeDBInstance
.When a DB instance is in a failure state and has a status of
failed
,incompatible-restore
, orincompatible-network
, you can only delete it when you skip creation of the final snapshot with theSkipFinalSnapshot
parameter.If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
-
The DB cluster is a read replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the
PromoteReadReplicaDBCluster
operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use theDeleteDBInstance
operation to delete the final instance in the DB cluster.For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
This is a convenience which creates an instance of the
DeleteDbInstanceRequest.Builder
avoiding the need to create one manually viaDeleteDbInstanceRequest.builder()
- Parameters:
deleteDbInstanceRequest
- AConsumer
that will call methods onDeleteDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbInstanceAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
-
deleteDBInstanceAutomatedBackup
default CompletableFuture<DeleteDbInstanceAutomatedBackupResponse> deleteDBInstanceAutomatedBackup(DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest) Deletes automated backups using the
DbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.- Parameters:
deleteDbInstanceAutomatedBackupRequest
- Parameter input for theDeleteDBInstanceAutomatedBackup
operation.- Returns:
- A Java Future containing the result of the DeleteDBInstanceAutomatedBackup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceAutomatedBackupStateException The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBInstanceAutomatedBackup
default CompletableFuture<DeleteDbInstanceAutomatedBackupResponse> deleteDBInstanceAutomatedBackup(Consumer<DeleteDbInstanceAutomatedBackupRequest.Builder> deleteDbInstanceAutomatedBackupRequest) Deletes automated backups using the
DbiResourceId
value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
This is a convenience which creates an instance of the
DeleteDbInstanceAutomatedBackupRequest.Builder
avoiding the need to create one manually viaDeleteDbInstanceAutomatedBackupRequest.builder()
- Parameters:
deleteDbInstanceAutomatedBackupRequest
- AConsumer
that will call methods onDeleteDbInstanceAutomatedBackupRequest.Builder
to create a request. Parameter input for theDeleteDBInstanceAutomatedBackup
operation.- Returns:
- A Java Future containing the result of the DeleteDBInstanceAutomatedBackup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceAutomatedBackupStateException The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBParameterGroup
default CompletableFuture<DeleteDbParameterGroupResponse> deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
- Parameters:
deleteDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBParameterGroup
default CompletableFuture<DeleteDbParameterGroupResponse> deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbParameterGroupRequest.builder()
- Parameters:
deleteDbParameterGroupRequest
- AConsumer
that will call methods onDeleteDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBProxy
default CompletableFuture<DeleteDbProxyResponse> deleteDBProxy(DeleteDbProxyRequest deleteDbProxyRequest) Deletes an existing DB proxy.
- Parameters:
deleteDbProxyRequest
-- Returns:
- A Java Future containing the result of the DeleteDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBProxy
default CompletableFuture<DeleteDbProxyResponse> deleteDBProxy(Consumer<DeleteDbProxyRequest.Builder> deleteDbProxyRequest) Deletes an existing DB proxy.
This is a convenience which creates an instance of the
DeleteDbProxyRequest.Builder
avoiding the need to create one manually viaDeleteDbProxyRequest.builder()
- Parameters:
deleteDbProxyRequest
- AConsumer
that will call methods onDeleteDbProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBProxyEndpoint
default CompletableFuture<DeleteDbProxyEndpointResponse> deleteDBProxyEndpoint(DeleteDbProxyEndpointRequest deleteDbProxyEndpointRequest) Deletes a
DBProxyEndpoint
. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.- Parameters:
deleteDbProxyEndpointRequest
-- Returns:
- A Java Future containing the result of the DeleteDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't exist.
- InvalidDbProxyEndpointStateException You can't perform this operation while the DB proxy endpoint is in a particular 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBProxyEndpoint
default CompletableFuture<DeleteDbProxyEndpointResponse> deleteDBProxyEndpoint(Consumer<DeleteDbProxyEndpointRequest.Builder> deleteDbProxyEndpointRequest) Deletes a
DBProxyEndpoint
. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.
This is a convenience which creates an instance of the
DeleteDbProxyEndpointRequest.Builder
avoiding the need to create one manually viaDeleteDbProxyEndpointRequest.builder()
- Parameters:
deleteDbProxyEndpointRequest
- AConsumer
that will call methods onDeleteDbProxyEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't exist.
- InvalidDbProxyEndpointStateException You can't perform this operation while the DB proxy endpoint is in a particular 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSecurityGroup
default CompletableFuture<DeleteDbSecurityGroupResponse> deleteDBSecurityGroup(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest) Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Parameters:
deleteDbSecurityGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSecurityGroup
default CompletableFuture<DeleteDbSecurityGroupResponse> deleteDBSecurityGroup(Consumer<DeleteDbSecurityGroupRequest.Builder> deleteDbSecurityGroupRequest) Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DeleteDbSecurityGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbSecurityGroupRequest.builder()
- Parameters:
deleteDbSecurityGroupRequest
- AConsumer
that will call methods onDeleteDbSecurityGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBSecurityGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBShardGroup
default CompletableFuture<DeleteDbShardGroupResponse> deleteDBShardGroup(DeleteDbShardGroupRequest deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.
- Parameters:
deleteDbShardGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidDbShardGroupStateException The DB shard group must be in the available state.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBShardGroup
default CompletableFuture<DeleteDbShardGroupResponse> deleteDBShardGroup(Consumer<DeleteDbShardGroupRequest.Builder> deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.
This is a convenience which creates an instance of the
DeleteDbShardGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbShardGroupRequest.builder()
- Parameters:
deleteDbShardGroupRequest
- AConsumer
that will call methods onDeleteDbShardGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidDbShardGroupStateException The DB shard group must be in the available state.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSnapshot
default CompletableFuture<DeleteDbSnapshotResponse> deleteDBSnapshot(DeleteDbSnapshotRequest deleteDbSnapshotRequest) Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the
available
state to be deleted.- Parameters:
deleteDbSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSnapshot
default CompletableFuture<DeleteDbSnapshotResponse> deleteDBSnapshot(Consumer<DeleteDbSnapshotRequest.Builder> deleteDbSnapshotRequest) Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the
available
state to be deleted.
This is a convenience which creates an instance of the
DeleteDbSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteDbSnapshotRequest.builder()
- Parameters:
deleteDbSnapshotRequest
- AConsumer
that will call methods onDeleteDbSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSubnetGroup
default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidDbSubnetStateException The DB subnet isn't in the available state.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDBSubnetGroup
default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbSubnetGroupRequest.builder()
- Parameters:
deleteDbSubnetGroupRequest
- AConsumer
that will call methods onDeleteDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidDbSubnetStateException The DB subnet isn't in the available state.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The subscription name does not exist.
- InvalidEventSubscriptionStateException This error can occur if someone else is modifying a subscription. You should retry the action.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventSubscription
default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.
This is a convenience which creates an instance of the
DeleteEventSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubscriptionNotFoundException The subscription name does not exist.
- InvalidEventSubscriptionStateException This error can occur if someone else is modifying a subscription. You should retry the action.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGlobalCluster
default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
- Parameters:
deleteGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
deleteGlobalCluster
default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
DeleteGlobalClusterRequest.Builder
avoiding the need to create one manually viaDeleteGlobalClusterRequest.builder()
- Parameters:
deleteGlobalClusterRequest
- AConsumer
that will call methods onDeleteGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
deleteIntegration
default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.
- Parameters:
deleteIntegrationRequest
-- Returns:
- A Java Future containing the result of the DeleteIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration could not be found.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- InvalidIntegrationStateException The integration is in an invalid state and can't perform the requested operation.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntegration
default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.
This is a convenience which creates an instance of the
DeleteIntegrationRequest.Builder
avoiding the need to create one manually viaDeleteIntegrationRequest.builder()
- Parameters:
deleteIntegrationRequest
- AConsumer
that will call methods onDeleteIntegrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration could not be found.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- InvalidIntegrationStateException The integration is in an invalid state and can't perform the requested operation.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptionGroup
default CompletableFuture<DeleteOptionGroupResponse> deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) Deletes an existing option group.
- Parameters:
deleteOptionGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group could not be found.
- InvalidOptionGroupStateException The option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptionGroup
default CompletableFuture<DeleteOptionGroupResponse> deleteOptionGroup(Consumer<DeleteOptionGroupRequest.Builder> deleteOptionGroupRequest) Deletes an existing option group.
This is a convenience which creates an instance of the
DeleteOptionGroupRequest.Builder
avoiding the need to create one manually viaDeleteOptionGroupRequest.builder()
- Parameters:
deleteOptionGroupRequest
- AConsumer
that will call methods onDeleteOptionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group could not be found.
- InvalidOptionGroupStateException The option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTenantDatabase
default CompletableFuture<DeleteTenantDatabaseResponse> deleteTenantDatabase(DeleteTenantDatabaseRequest deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
- Parameters:
deleteTenantDatabaseRequest
-- Returns:
- A Java Future containing the result of the DeleteTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
deleteTenantDatabase
default CompletableFuture<DeleteTenantDatabaseResponse> deleteTenantDatabase(Consumer<DeleteTenantDatabaseRequest.Builder> deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
This is a convenience which creates an instance of the
DeleteTenantDatabaseRequest.Builder
avoiding the need to create one manually viaDeleteTenantDatabaseRequest.builder()
- Parameters:
deleteTenantDatabaseRequest
- AConsumer
that will call methods onDeleteTenantDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
deregisterDBProxyTargets
default CompletableFuture<DeregisterDbProxyTargetsResponse> deregisterDBProxyTargets(DeregisterDbProxyTargetsRequest deregisterDbProxyTargetsRequest) Remove the association between one or more
DBProxyTarget
data structures and aDBProxyTargetGroup
.- Parameters:
deregisterDbProxyTargetsRequest
-- Returns:
- A Java Future containing the result of the DeregisterDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterDBProxyTargets
default CompletableFuture<DeregisterDbProxyTargetsResponse> deregisterDBProxyTargets(Consumer<DeregisterDbProxyTargetsRequest.Builder> deregisterDbProxyTargetsRequest) Remove the association between one or more
DBProxyTarget
data structures and aDBProxyTargetGroup
.
This is a convenience which creates an instance of the
DeregisterDbProxyTargetsRequest.Builder
avoiding the need to create one manually viaDeregisterDbProxyTargetsRequest.builder()
- Parameters:
deregisterDbProxyTargetsRequest
- AConsumer
that will call methods onDeregisterDbProxyTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
- Parameters:
describeAccountAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBlueGreenDeployments
default CompletableFuture<DescribeBlueGreenDeploymentsResponse> describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Parameters:
describeBlueGreenDeploymentsRequest
-- Returns:
- A Java Future containing the result of the DescribeBlueGreenDeployments operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
describeBlueGreenDeployments
default CompletableFuture<DescribeBlueGreenDeploymentsResponse> describeBlueGreenDeployments(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
DescribeBlueGreenDeploymentsRequest.Builder
avoiding the need to create one manually viaDescribeBlueGreenDeploymentsRequest.builder()
- Parameters:
describeBlueGreenDeploymentsRequest
- AConsumer
that will call methods onDescribeBlueGreenDeploymentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBlueGreenDeployments operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
describeBlueGreenDeploymentsPaginator
default DescribeBlueGreenDeploymentsPublisher describeBlueGreenDeploymentsPaginator(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) This is a variant of
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsPublisher publisher = client.describeBlueGreenDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsPublisher publisher = client.describeBlueGreenDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse response) { //... }; });
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
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation.- Parameters:
describeBlueGreenDeploymentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
describeBlueGreenDeploymentsPaginator
default DescribeBlueGreenDeploymentsPublisher describeBlueGreenDeploymentsPaginator(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) This is a variant of
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsPublisher publisher = client.describeBlueGreenDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsPublisher publisher = client.describeBlueGreenDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse response) { //... }; });
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
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeBlueGreenDeploymentsRequest.Builder
avoiding the need to create one manually viaDescribeBlueGreenDeploymentsRequest.builder()
- Parameters:
describeBlueGreenDeploymentsRequest
- AConsumer
that will call methods onDescribeBlueGreenDeploymentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
describeCertificates
default CompletableFuture<DescribeCertificatesResponse> describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Parameters:
describeCertificatesRequest
-- Returns:
- A Java Future containing the result of the DescribeCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeCertificates
default CompletableFuture<DescribeCertificatesResponse> describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
DescribeCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeCertificatesRequest.builder()
- Parameters:
describeCertificatesRequest
- AConsumer
that will call methods onDescribeCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeCertificates
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Returns:
- A Java Future containing the result of the DescribeCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeCertificatesPaginator
This is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response) { //... }; });
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.rds.model.DescribeCertificatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesPublisher describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest) This is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response) { //... }; });
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.rds.model.DescribeCertificatesRequest)
operation.- Parameters:
describeCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesPublisher describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) This is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response) { //... }; });
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.rds.model.DescribeCertificatesRequest)
operation.
This is a convenience which creates an instance of the
DescribeCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeCertificatesRequest.builder()
- Parameters:
describeCertificatesRequest
- AConsumer
that will call methods onDescribeCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
describeDBClusterAutomatedBackups
default CompletableFuture<DescribeDbClusterAutomatedBackupsResponse> describeDBClusterAutomatedBackups(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the
DescribeDBClusterAutomatedBackups
andDescribeDBClusters
operations.All parameters are optional.
- Parameters:
describeDbClusterAutomatedBackupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterAutomatedBackups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBClusterAutomatedBackups
default CompletableFuture<DescribeDbClusterAutomatedBackupsResponse> describeDBClusterAutomatedBackups(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the
DescribeDBClusterAutomatedBackups
andDescribeDBClusters
operations.All parameters are optional.
This is a convenience which creates an instance of the
DescribeDbClusterAutomatedBackupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterAutomatedBackupsRequest.builder()
- Parameters:
describeDbClusterAutomatedBackupsRequest
- AConsumer
that will call methods onDescribeDbClusterAutomatedBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterAutomatedBackups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBClusterAutomatedBackupsPaginator
default DescribeDBClusterAutomatedBackupsPublisher describeDBClusterAutomatedBackupsPaginator(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) This is a variant of
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsPublisher publisher = client.describeDBClusterAutomatedBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsPublisher publisher = client.describeDBClusterAutomatedBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse response) { //... }; });
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
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation.- Parameters:
describeDbClusterAutomatedBackupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBClusterAutomatedBackupsPaginator
default DescribeDBClusterAutomatedBackupsPublisher describeDBClusterAutomatedBackupsPaginator(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) This is a variant of
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsPublisher publisher = client.describeDBClusterAutomatedBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsPublisher publisher = client.describeDBClusterAutomatedBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse response) { //... }; });
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
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterAutomatedBackupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterAutomatedBackupsRequest.builder()
- Parameters:
describeDbClusterAutomatedBackupsRequest
- AConsumer
that will call methods onDescribeDbClusterAutomatedBackupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBClusterBacktracks
default CompletableFuture<DescribeDbClusterBacktracksResponse> describeDBClusterBacktracks(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
- Parameters:
describeDbClusterBacktracksRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterBacktracks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterBacktrackNotFoundException
BacktrackIdentifier
doesn't refer to an existing backtrack. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterBacktracks
default CompletableFuture<DescribeDbClusterBacktracksResponse> describeDBClusterBacktracks(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
This is a convenience which creates an instance of the
DescribeDbClusterBacktracksRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterBacktracksRequest.builder()
- Parameters:
describeDbClusterBacktracksRequest
- AConsumer
that will call methods onDescribeDbClusterBacktracksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterBacktracks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterBacktrackNotFoundException
BacktrackIdentifier
doesn't refer to an existing backtrack. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterBacktracksPaginator
default DescribeDBClusterBacktracksPublisher describeDBClusterBacktracksPaginator(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) This is a variant of
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksPublisher publisher = client.describeDBClusterBacktracksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksPublisher publisher = client.describeDBClusterBacktracksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse response) { //... }; });
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
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation.- Parameters:
describeDbClusterBacktracksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterBacktrackNotFoundException
BacktrackIdentifier
doesn't refer to an existing backtrack. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterBacktracksPaginator
default DescribeDBClusterBacktracksPublisher describeDBClusterBacktracksPaginator(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) This is a variant of
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksPublisher publisher = client.describeDBClusterBacktracksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksPublisher publisher = client.describeDBClusterBacktracksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse response) { //... }; });
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
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterBacktracksRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterBacktracksRequest.builder()
- Parameters:
describeDbClusterBacktracksRequest
- AConsumer
that will call methods onDescribeDbClusterBacktracksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterBacktrackNotFoundException
BacktrackIdentifier
doesn't refer to an existing backtrack. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpoints
default CompletableFuture<DescribeDbClusterEndpointsResponse> describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpoints
default CompletableFuture<DescribeDbClusterEndpointsResponse> describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpoints
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Returns:
- A Java Future containing the result of the DescribeDBClusterEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpointsPaginator
This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsPublisher describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsPublisher describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsPublisher publisher = client.describeDBClusterEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameterGroups
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups()Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Returns:
- A Java Future containing the result of the DescribeDBClusterParameterGroups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameterGroupsPaginator
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
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.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
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.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response) { //... }; });
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.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameters
default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParameters
default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse response) { //... }; });
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.rds.model.DescribeDbClusterParametersRequest)
operation.- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse response) { //... }; });
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.rds.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBClusterSnapshotAttributes
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the
ModifyDBClusterSnapshotAttribute
API action.- Parameters:
describeDbClusterSnapshotAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshotAttributes
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the
ModifyDBClusterSnapshotAttribute
API action.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()
- Parameters:
describeDbClusterSnapshotAttributesRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshots
default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshots
default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshots
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Returns:
- A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshotsPaginator
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
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.rds.model.DescribeDbClusterSnapshotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
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.rds.model.DescribeDbClusterSnapshotsRequest)
operation.- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response) { //... }; });
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.rds.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
describeDBClusters
default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
- Parameters:
describeDbClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusters
default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClusters
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
- Returns:
- A Java Future containing the result of the DescribeDBClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClustersPaginator
This is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response) { //... }; });
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.rds.model.DescribeDbClustersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersPublisher describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) This is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response) { //... }; });
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.rds.model.DescribeDbClustersRequest)
operation.- Parameters:
describeDbClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersPublisher describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response) { //... }; });
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.rds.model.DescribeDbClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
describeDBEngineVersions
default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.
- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBEngineVersions
default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBEngineVersions
Describes the properties of specific versions of DB engines.
- Returns:
- A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBEngineVersionsPaginator
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response) { //... }; });
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.rds.model.DescribeDbEngineVersionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response) { //... }; });
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.rds.model.DescribeDbEngineVersionsRequest)
operation.- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response) { //... }; });
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.rds.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackups
default CompletableFuture<DescribeDbInstanceAutomatedBackupsResponse> describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
andDescribeDBInstances
operations.All parameters are optional.
- Parameters:
describeDbInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.- Returns:
- A Java Future containing the result of the DescribeDBInstanceAutomatedBackups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackups
default CompletableFuture<DescribeDbInstanceAutomatedBackupsResponse> describeDBInstanceAutomatedBackups(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
andDescribeDBInstances
operations.All parameters are optional.
This is a convenience which creates an instance of the
DescribeDbInstanceAutomatedBackupsRequest.Builder
avoiding the need to create one manually viaDescribeDbInstanceAutomatedBackupsRequest.builder()
- Parameters:
describeDbInstanceAutomatedBackupsRequest
- AConsumer
that will call methods onDescribeDbInstanceAutomatedBackupsRequest.Builder
to create a request. Parameter input for DescribeDBInstanceAutomatedBackups.- Returns:
- A Java Future containing the result of the DescribeDBInstanceAutomatedBackups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackups
default CompletableFuture<DescribeDbInstanceAutomatedBackupsResponse> describeDBInstanceAutomatedBackups()Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups
andDescribeDBInstances
operations.All parameters are optional.
- Returns:
- A Java Future containing the result of the DescribeDBInstanceAutomatedBackups operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
This is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response) { //... }; });
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
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
default DescribeDBInstanceAutomatedBackupsPublisher describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) This is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response) { //... }; });
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
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.- Parameters:
describeDbInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
default DescribeDBInstanceAutomatedBackupsPublisher describeDBInstanceAutomatedBackupsPaginator(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) This is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsPublisher publisher = client.describeDBInstanceAutomatedBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response) { //... }; });
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
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbInstanceAutomatedBackupsRequest.Builder
avoiding the need to create one manually viaDescribeDbInstanceAutomatedBackupsRequest.builder()
- Parameters:
describeDbInstanceAutomatedBackupsRequest
- AConsumer
that will call methods onDescribeDbInstanceAutomatedBackupsRequest.Builder
to create a request. Parameter input for DescribeDBInstanceAutomatedBackups.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBInstances
default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
- Parameters:
describeDbInstancesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBInstances
default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBInstances
Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
- Returns:
- A Java Future containing the result of the DescribeDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBInstancesPaginator
This is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response) { //... }; });
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.rds.model.DescribeDbInstancesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesPublisher describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response) { //... }; });
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.rds.model.DescribeDbInstancesRequest)
operation.- Parameters:
describeDbInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesPublisher describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response) { //... }; });
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.rds.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBLogFiles
default CompletableFuture<DescribeDbLogFilesResponse> describeDBLogFiles(DescribeDbLogFilesRequest describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
- Parameters:
describeDbLogFilesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBLogFiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBLogFiles
default CompletableFuture<DescribeDbLogFilesResponse> describeDBLogFiles(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
DescribeDbLogFilesRequest.Builder
avoiding the need to create one manually viaDescribeDbLogFilesRequest.builder()
- Parameters:
describeDbLogFilesRequest
- AConsumer
that will call methods onDescribeDbLogFilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBLogFiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBLogFilesPaginator
default DescribeDBLogFilesPublisher describeDBLogFilesPaginator(DescribeDbLogFilesRequest describeDbLogFilesRequest) This is a variant of
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesPublisher publisher = client.describeDBLogFilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesPublisher publisher = client.describeDBLogFilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse response) { //... }; });
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
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.- Parameters:
describeDbLogFilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBLogFilesPaginator
default DescribeDBLogFilesPublisher describeDBLogFilesPaginator(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) This is a variant of
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesPublisher publisher = client.describeDBLogFilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesPublisher publisher = client.describeDBLogFilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse response) { //... }; });
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
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbLogFilesRequest.Builder
avoiding the need to create one manually viaDescribeDbLogFilesRequest.builder()
- Parameters:
describeDbLogFilesRequest
- AConsumer
that will call methods onDescribeDbLogFilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeDBParameterGroups
default CompletableFuture<DescribeDbParameterGroupsResponse> describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameterGroups
default CompletableFuture<DescribeDbParameterGroupsResponse> describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameterGroups
Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Returns:
- A Java Future containing the result of the DescribeDBParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameterGroupsPaginator
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsPublisher describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsPublisher describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsPublisher publisher = client.describeDBParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameters
default CompletableFuture<DescribeDbParametersResponse> describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDbParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeDBParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParameters
default CompletableFuture<DescribeDbParametersResponse> describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersPublisher describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) This is a variant of
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.- Parameters:
describeDbParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersPublisher describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant of
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBParametersPublisher publisher = client.describeDBParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
describeDBProxies
default CompletableFuture<DescribeDbProxiesResponse> describeDBProxies(DescribeDbProxiesRequest describeDbProxiesRequest) Returns information about DB proxies.
- Parameters:
describeDbProxiesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBProxies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxies
default CompletableFuture<DescribeDbProxiesResponse> describeDBProxies(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) Returns information about DB proxies.
This is a convenience which creates an instance of the
DescribeDbProxiesRequest.Builder
avoiding the need to create one manually viaDescribeDbProxiesRequest.builder()
- Parameters:
describeDbProxiesRequest
- AConsumer
that will call methods onDescribeDbProxiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBProxies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxiesPaginator
default DescribeDBProxiesPublisher describeDBProxiesPaginator(DescribeDbProxiesRequest describeDbProxiesRequest) This is a variant of
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesPublisher publisher = client.describeDBProxiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesPublisher publisher = client.describeDBProxiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse response) { //... }; });
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
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.- Parameters:
describeDbProxiesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxiesPaginator
default DescribeDBProxiesPublisher describeDBProxiesPaginator(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) This is a variant of
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesPublisher publisher = client.describeDBProxiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesPublisher publisher = client.describeDBProxiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse response) { //... }; });
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
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbProxiesRequest.Builder
avoiding the need to create one manually viaDescribeDbProxiesRequest.builder()
- Parameters:
describeDbProxiesRequest
- AConsumer
that will call methods onDescribeDbProxiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyEndpoints
default CompletableFuture<DescribeDbProxyEndpointsResponse> describeDBProxyEndpoints(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.
- Parameters:
describeDbProxyEndpointsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBProxyEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyEndpoints
default CompletableFuture<DescribeDbProxyEndpointsResponse> describeDBProxyEndpoints(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.
This is a convenience which creates an instance of the
DescribeDbProxyEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyEndpointsRequest.builder()
- Parameters:
describeDbProxyEndpointsRequest
- AConsumer
that will call methods onDescribeDbProxyEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBProxyEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyEndpointsPaginator
default DescribeDBProxyEndpointsPublisher describeDBProxyEndpointsPaginator(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) This is a variant of
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsPublisher publisher = client.describeDBProxyEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsPublisher publisher = client.describeDBProxyEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse response) { //... }; });
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
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.- Parameters:
describeDbProxyEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyEndpointsPaginator
default DescribeDBProxyEndpointsPublisher describeDBProxyEndpointsPaginator(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) This is a variant of
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsPublisher publisher = client.describeDBProxyEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsPublisher publisher = client.describeDBProxyEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse response) { //... }; });
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
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbProxyEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyEndpointsRequest.builder()
- Parameters:
describeDbProxyEndpointsRequest
- AConsumer
that will call methods onDescribeDbProxyEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetGroups
default CompletableFuture<DescribeDbProxyTargetGroupsResponse> describeDBProxyTargetGroups(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) Returns information about DB proxy target groups, represented by
DBProxyTargetGroup
data structures.- Parameters:
describeDbProxyTargetGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBProxyTargetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetGroups
default CompletableFuture<DescribeDbProxyTargetGroupsResponse> describeDBProxyTargetGroups(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) Returns information about DB proxy target groups, represented by
DBProxyTargetGroup
data structures.
This is a convenience which creates an instance of the
DescribeDbProxyTargetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyTargetGroupsRequest.builder()
- Parameters:
describeDbProxyTargetGroupsRequest
- AConsumer
that will call methods onDescribeDbProxyTargetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBProxyTargetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetGroupsPaginator
default DescribeDBProxyTargetGroupsPublisher describeDBProxyTargetGroupsPaginator(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) This is a variant of
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsPublisher publisher = client.describeDBProxyTargetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsPublisher publisher = client.describeDBProxyTargetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse response) { //... }; });
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
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation.- Parameters:
describeDbProxyTargetGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetGroupsPaginator
default DescribeDBProxyTargetGroupsPublisher describeDBProxyTargetGroupsPaginator(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) This is a variant of
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsPublisher publisher = client.describeDBProxyTargetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsPublisher publisher = client.describeDBProxyTargetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse response) { //... }; });
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
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbProxyTargetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyTargetGroupsRequest.builder()
- Parameters:
describeDbProxyTargetGroupsRequest
- AConsumer
that will call methods onDescribeDbProxyTargetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargets
default CompletableFuture<DescribeDbProxyTargetsResponse> describeDBProxyTargets(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) Returns information about
DBProxyTarget
objects. This API supports pagination.- Parameters:
describeDbProxyTargetsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargets
default CompletableFuture<DescribeDbProxyTargetsResponse> describeDBProxyTargets(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) Returns information about
DBProxyTarget
objects. This API supports pagination.
This is a convenience which creates an instance of the
DescribeDbProxyTargetsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyTargetsRequest.builder()
- Parameters:
describeDbProxyTargetsRequest
- AConsumer
that will call methods onDescribeDbProxyTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetsPaginator
default DescribeDBProxyTargetsPublisher describeDBProxyTargetsPaginator(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) This is a variant of
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsPublisher publisher = client.describeDBProxyTargetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsPublisher publisher = client.describeDBProxyTargetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse response) { //... }; });
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
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.- Parameters:
describeDbProxyTargetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBProxyTargetsPaginator
default DescribeDBProxyTargetsPublisher describeDBProxyTargetsPaginator(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) This is a variant of
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsPublisher publisher = client.describeDBProxyTargetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsPublisher publisher = client.describeDBProxyTargetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse response) { //... }; });
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
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbProxyTargetsRequest.Builder
avoiding the need to create one manually viaDescribeDbProxyTargetsRequest.builder()
- Parameters:
describeDbProxyTargetsRequest
- AConsumer
that will call methods onDescribeDbProxyTargetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetNotFoundException The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBRecommendations
default CompletableFuture<DescribeDbRecommendationsResponse> describeDBRecommendations(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
- Parameters:
describeDbRecommendationsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBRecommendations
default CompletableFuture<DescribeDbRecommendationsResponse> describeDBRecommendations(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
This is a convenience which creates an instance of the
DescribeDbRecommendationsRequest.Builder
avoiding the need to create one manually viaDescribeDbRecommendationsRequest.builder()
- Parameters:
describeDbRecommendationsRequest
- AConsumer
that will call methods onDescribeDbRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBRecommendationsPaginator
default DescribeDBRecommendationsPublisher describeDBRecommendationsPaginator(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) This is a variant of
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsPublisher publisher = client.describeDBRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsPublisher publisher = client.describeDBRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse response) { //... }; });
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
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation.- Parameters:
describeDbRecommendationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBRecommendationsPaginator
default DescribeDBRecommendationsPublisher describeDBRecommendationsPaginator(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) This is a variant of
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsPublisher publisher = client.describeDBRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsPublisher publisher = client.describeDBRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse response) { //... }; });
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
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbRecommendationsRequest.Builder
avoiding the need to create one manually viaDescribeDbRecommendationsRequest.builder()
- Parameters:
describeDbRecommendationsRequest
- AConsumer
that will call methods onDescribeDbRecommendationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBSecurityGroups
default CompletableFuture<DescribeDbSecurityGroupsResponse> describeDBSecurityGroups(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Parameters:
describeDbSecurityGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSecurityGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBSecurityGroups
default CompletableFuture<DescribeDbSecurityGroupsResponse> describeDBSecurityGroups(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
DescribeDbSecurityGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSecurityGroupsRequest.builder()
- Parameters:
describeDbSecurityGroupsRequest
- AConsumer
that will call methods onDescribeDbSecurityGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSecurityGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBSecurityGroups
Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Returns:
- A Java Future containing the result of the DescribeDBSecurityGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBSecurityGroupsPaginator
This is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response) { //... }; });
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
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBSecurityGroupsPaginator
default DescribeDBSecurityGroupsPublisher describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) This is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response) { //... }; });
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
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.- Parameters:
describeDbSecurityGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBSecurityGroupsPaginator
default DescribeDBSecurityGroupsPublisher describeDBSecurityGroupsPaginator(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) This is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsPublisher publisher = client.describeDBSecurityGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response) { //... }; });
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
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSecurityGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSecurityGroupsRequest.builder()
- Parameters:
describeDbSecurityGroupsRequest
- AConsumer
that will call methods onDescribeDbSecurityGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
describeDBShardGroups
default CompletableFuture<DescribeDbShardGroupsResponse> describeDBShardGroups(DescribeDbShardGroupsRequest describeDbShardGroupsRequest) Describes existing Aurora Limitless Database DB shard groups.
- Parameters:
describeDbShardGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBShardGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBShardGroups
default CompletableFuture<DescribeDbShardGroupsResponse> describeDBShardGroups(Consumer<DescribeDbShardGroupsRequest.Builder> describeDbShardGroupsRequest) Describes existing Aurora Limitless Database DB shard groups.
This is a convenience which creates an instance of the
DescribeDbShardGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbShardGroupsRequest.builder()
- Parameters:
describeDbShardGroupsRequest
- AConsumer
that will call methods onDescribeDbShardGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBShardGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDBSnapshotAttributes
default CompletableFuture<DescribeDbSnapshotAttributesResponse> describeDBSnapshotAttributes(DescribeDbSnapshotAttributesRequest describeDbSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts,
DescribeDBSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the
ModifyDBSnapshotAttribute
API action.- Parameters:
describeDbSnapshotAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotAttributes
default CompletableFuture<DescribeDbSnapshotAttributesResponse> describeDBSnapshotAttributes(Consumer<DescribeDbSnapshotAttributesRequest.Builder> describeDbSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts,
DescribeDBSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the
ModifyDBSnapshotAttribute
API action.
This is a convenience which creates an instance of the
DescribeDbSnapshotAttributesRequest.Builder
avoiding the need to create one manually viaDescribeDbSnapshotAttributesRequest.builder()
- Parameters:
describeDbSnapshotAttributesRequest
- AConsumer
that will call methods onDescribeDbSnapshotAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSnapshotAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotTenantDatabases
default CompletableFuture<DescribeDbSnapshotTenantDatabasesResponse> describeDBSnapshotTenantDatabases(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
- Parameters:
describeDbSnapshotTenantDatabasesRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSnapshotTenantDatabases operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotTenantDatabases
default CompletableFuture<DescribeDbSnapshotTenantDatabasesResponse> describeDBSnapshotTenantDatabases(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
This is a convenience which creates an instance of the
DescribeDbSnapshotTenantDatabasesRequest.Builder
avoiding the need to create one manually viaDescribeDbSnapshotTenantDatabasesRequest.builder()
- Parameters:
describeDbSnapshotTenantDatabasesRequest
- AConsumer
that will call methods onDescribeDbSnapshotTenantDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSnapshotTenantDatabases operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotTenantDatabasesPaginator
default DescribeDBSnapshotTenantDatabasesPublisher describeDBSnapshotTenantDatabasesPaginator(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) This is a variant of
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesPublisher publisher = client.describeDBSnapshotTenantDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesPublisher publisher = client.describeDBSnapshotTenantDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse response) { //... }; });
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
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation.- Parameters:
describeDbSnapshotTenantDatabasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotTenantDatabasesPaginator
default DescribeDBSnapshotTenantDatabasesPublisher describeDBSnapshotTenantDatabasesPaginator(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) This is a variant of
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesPublisher publisher = client.describeDBSnapshotTenantDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesPublisher publisher = client.describeDBSnapshotTenantDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse response) { //... }; });
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
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSnapshotTenantDatabasesRequest.Builder
avoiding the need to create one manually viaDescribeDbSnapshotTenantDatabasesRequest.builder()
- Parameters:
describeDbSnapshotTenantDatabasesRequest
- AConsumer
that will call methods onDescribeDbSnapshotTenantDatabasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshots
default CompletableFuture<DescribeDbSnapshotsResponse> describeDBSnapshots(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) Returns information about DB snapshots. This API action supports pagination.
- Parameters:
describeDbSnapshotsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshots
default CompletableFuture<DescribeDbSnapshotsResponse> describeDBSnapshots(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) Returns information about DB snapshots. This API action supports pagination.
This is a convenience which creates an instance of the
DescribeDbSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbSnapshotsRequest.builder()
- Parameters:
describeDbSnapshotsRequest
- AConsumer
that will call methods onDescribeDbSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshots
Returns information about DB snapshots. This API action supports pagination.
- Returns:
- A Java Future containing the result of the DescribeDBSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotsPaginator
This is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response) { //... }; });
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
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotsPaginator
default DescribeDBSnapshotsPublisher describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) This is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response) { //... }; });
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
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.- Parameters:
describeDbSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSnapshotsPaginator
default DescribeDBSnapshotsPublisher describeDBSnapshotsPaginator(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) This is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsPublisher publisher = client.describeDBSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response) { //... }; });
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
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbSnapshotsRequest.builder()
- Parameters:
describeDbSnapshotsRequest
- AConsumer
that will call methods onDescribeDbSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
describeDBSubnetGroups
default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeDBSubnetGroups
default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeDBSubnetGroups
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Returns:
- A Java Future containing the result of the DescribeDBSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeDBSubnetGroupsPaginator
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response) { //... }; });
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.rds.model.DescribeDbSubnetGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response) { //... }; });
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.rds.model.DescribeDbSubnetGroupsRequest)
operation.- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response) { //... }; });
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.rds.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
describeEngineDefaultClusterParameters
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
- Parameters:
describeEngineDefaultClusterParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineDefaultClusterParameters
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultClusterParametersRequest.builder()
- Parameters:
describeEngineDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineDefaultParameters
default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineDefaultParameters
default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation.- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse response) { //... }; });
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
- Parameters:
describeEventCategoriesRequest
-- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventCategories
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
This is a convenience which creates an instance of the
DescribeEventCategoriesRequest.Builder
avoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventCategories
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
- Returns:
- A Java Future containing the result of the DescribeEventCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
,SNSTopicARN
,CustomerID
,SourceType
,SourceID
,CreationTime
, andStatus
.If you specify a
SubscriptionName
, lists the description for that subscription.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
,SNSTopicARN
,CustomerID
,SourceType
,SourceID
,CreationTime
, andStatus
.If you specify a
SubscriptionName
, lists the description for that subscription.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptions
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.- Returns:
- A Java Future containing the result of the DescribeEventSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response) { //... }; });
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.rds.model.DescribeEventSubscriptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response) { //... }; });
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.rds.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response) { //... }; });
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.rds.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
- Parameters:
describeEventsRequest
-- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
This is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventsResponse response) { //... }; });
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.rds.model.DescribeEventsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventsResponse response) { //... }; });
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.rds.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeEventsResponse response) { //... }; });
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.rds.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExportTasks
default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
- Parameters:
describeExportTasksRequest
-- Returns:
- A Java Future containing the result of the DescribeExportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExportTasks
default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
This is a convenience which creates an instance of the
DescribeExportTasksRequest.Builder
avoiding the need to create one manually viaDescribeExportTasksRequest.builder()
- Parameters:
describeExportTasksRequest
- AConsumer
that will call methods onDescribeExportTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeExportTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksPublisher describeExportTasksPaginator(DescribeExportTasksRequest describeExportTasksRequest) This is a variant of
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse response) { //... }; });
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
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.- Parameters:
describeExportTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksPublisher describeExportTasksPaginator(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant of
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeExportTasksPublisher publisher = client.describeExportTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse response) { //... }; });
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
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.
This is a convenience which creates an instance of the
DescribeExportTasksRequest.Builder
avoiding the need to create one manually viaDescribeExportTasksRequest.builder()
- Parameters:
describeExportTasksRequest
- AConsumer
that will call methods onDescribeExportTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExportTaskNotFoundException The export task doesn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGlobalClusters
default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
- Parameters:
describeGlobalClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeGlobalClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClusters
default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGlobalClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClusters
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
- Returns:
- A Java Future containing the result of the DescribeGlobalClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClustersPaginator
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response) { //... }; });
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.rds.model.DescribeGlobalClustersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response) { //... }; });
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.rds.model.DescribeGlobalClustersRequest)
operation.- Parameters:
describeGlobalClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response) { //... }; });
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.rds.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
describeIntegrations
default CompletableFuture<DescribeIntegrationsResponse> describeIntegrations(DescribeIntegrationsRequest describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.
- Parameters:
describeIntegrationsRequest
-- Returns:
- A Java Future containing the result of the DescribeIntegrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIntegrations
default CompletableFuture<DescribeIntegrationsResponse> describeIntegrations(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.
This is a convenience which creates an instance of the
DescribeIntegrationsRequest.Builder
avoiding the need to create one manually viaDescribeIntegrationsRequest.builder()
- Parameters:
describeIntegrationsRequest
- AConsumer
that will call methods onDescribeIntegrationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeIntegrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIntegrationsPaginator
default DescribeIntegrationsPublisher describeIntegrationsPaginator(DescribeIntegrationsRequest describeIntegrationsRequest) This is a variant of
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsPublisher publisher = client.describeIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeIntegrationsPublisher publisher = client.describeIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse response) { //... }; });
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
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.- Parameters:
describeIntegrationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIntegrationsPaginator
default DescribeIntegrationsPublisher describeIntegrationsPaginator(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) This is a variant of
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsPublisher publisher = client.describeIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeIntegrationsPublisher publisher = client.describeIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse response) { //... }; });
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
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeIntegrationsRequest.Builder
avoiding the need to create one manually viaDescribeIntegrationsRequest.builder()
- Parameters:
describeIntegrationsRequest
- AConsumer
that will call methods onDescribeIntegrationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupOptions
default CompletableFuture<DescribeOptionGroupOptionsResponse> describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) Describes all available options for the specified engine.
- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeOptionGroupOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupOptions
default CompletableFuture<DescribeOptionGroupOptionsResponse> describeOptionGroupOptions(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) Describes all available options for the specified engine.
This is a convenience which creates an instance of the
DescribeOptionGroupOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOptionGroupOptionsRequest.builder()
- Parameters:
describeOptionGroupOptionsRequest
- AConsumer
that will call methods onDescribeOptionGroupOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOptionGroupOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupOptionsPaginator
default DescribeOptionGroupOptionsPublisher describeOptionGroupOptionsPaginator(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) This is a variant of
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsPublisher publisher = client.describeOptionGroupOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsPublisher publisher = client.describeOptionGroupOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse response) { //... }; });
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
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation.- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupOptionsPaginator
default DescribeOptionGroupOptionsPublisher describeOptionGroupOptionsPaginator(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) This is a variant of
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsPublisher publisher = client.describeOptionGroupOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsPublisher publisher = client.describeOptionGroupOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse response) { //... }; });
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
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOptionGroupOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOptionGroupOptionsRequest.builder()
- Parameters:
describeOptionGroupOptionsRequest
- AConsumer
that will call methods onDescribeOptionGroupOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroups
default CompletableFuture<DescribeOptionGroupsResponse> describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.
- Parameters:
describeOptionGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeOptionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroups
default CompletableFuture<DescribeOptionGroupsResponse> describeOptionGroups(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) Describes the available option groups.
This is a convenience which creates an instance of the
DescribeOptionGroupsRequest.Builder
avoiding the need to create one manually viaDescribeOptionGroupsRequest.builder()
- Parameters:
describeOptionGroupsRequest
- AConsumer
that will call methods onDescribeOptionGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOptionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroups
Describes the available option groups.
- Returns:
- A Java Future containing the result of the DescribeOptionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupsPaginator
This is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response) { //... }; });
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
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupsPaginator
default DescribeOptionGroupsPublisher describeOptionGroupsPaginator(DescribeOptionGroupsRequest describeOptionGroupsRequest) This is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response) { //... }; });
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
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.- Parameters:
describeOptionGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptionGroupsPaginator
default DescribeOptionGroupsPublisher describeOptionGroupsPaginator(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) This is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsPublisher publisher = client.describeOptionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response) { //... }; });
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
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOptionGroupsRequest.Builder
avoiding the need to create one manually viaDescribeOptionGroupsRequest.builder()
- Parameters:
describeOptionGroupsRequest
- AConsumer
that will call methods onDescribeOptionGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableDBInstanceOptions
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Describes the orderable DB instance options for a specified DB engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableDBInstanceOptions
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) Describes the orderable DB instance options for a specified DB engine.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse response) { //... }; });
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.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation.- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse response) { //... }; });
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.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActions
default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions()Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Returns:
- A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActionsPaginator
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
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.rds.model.DescribePendingMaintenanceActionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
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.rds.model.DescribePendingMaintenanceActionsRequest)
operation.- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response) { //... }; });
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.rds.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstances
default CompletableFuture<DescribeReservedDbInstancesResponse> describeReservedDBInstances(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Parameters:
describeReservedDbInstancesRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstances
default CompletableFuture<DescribeReservedDbInstancesResponse> describeReservedDBInstances(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
This is a convenience which creates an instance of the
DescribeReservedDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeReservedDbInstancesRequest.builder()
- Parameters:
describeReservedDbInstancesRequest
- AConsumer
that will call methods onDescribeReservedDbInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstances
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Returns:
- A Java Future containing the result of the DescribeReservedDBInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferings
default CompletableFuture<DescribeReservedDbInstancesOfferingsResponse> describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) Lists available reserved DB instance offerings.
- Parameters:
describeReservedDbInstancesOfferingsRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedDBInstancesOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferings
default CompletableFuture<DescribeReservedDbInstancesOfferingsResponse> describeReservedDBInstancesOfferings(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) Lists available reserved DB instance offerings.
This is a convenience which creates an instance of the
DescribeReservedDbInstancesOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedDbInstancesOfferingsRequest.builder()
- Parameters:
describeReservedDbInstancesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedDbInstancesOfferingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedDBInstancesOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferings
default CompletableFuture<DescribeReservedDbInstancesOfferingsResponse> describeReservedDBInstancesOfferings()Lists available reserved DB instance offerings.
- Returns:
- A Java Future containing the result of the DescribeReservedDBInstancesOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsPublisher describeReservedDBInstancesOfferingsPaginator()This is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response) { //... }; });
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
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsPublisher describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) This is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response) { //... }; });
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
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.- Parameters:
describeReservedDbInstancesOfferingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsPublisher describeReservedDBInstancesOfferingsPaginator(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) This is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsPublisher publisher = client.describeReservedDBInstancesOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response) { //... }; });
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
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedDbInstancesOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedDbInstancesOfferingsRequest.builder()
- Parameters:
describeReservedDbInstancesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedDbInstancesOfferingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesPaginator
This is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response) { //... }; });
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
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesPaginator
default DescribeReservedDBInstancesPublisher describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) This is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response) { //... }; });
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
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.- Parameters:
describeReservedDbInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedDBInstancesPaginator
default DescribeReservedDBInstancesPublisher describeReservedDBInstancesPaginator(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) This is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesPublisher publisher = client.describeReservedDBInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response) { //... }; });
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
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeReservedDbInstancesRequest.builder()
- Parameters:
describeReservedDbInstancesRequest
- AConsumer
that will call methods onDescribeReservedDbInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstanceNotFoundException The specified reserved DB Instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegions
default CompletableFuture<DescribeSourceRegionsResponse> describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest) Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation
DescribeRegions
. For more information, see DescribeRegions in the Amazon EC2 API Reference.- Parameters:
describeSourceRegionsRequest
-- Returns:
- A Java Future containing the result of the DescribeSourceRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegions
default CompletableFuture<DescribeSourceRegionsResponse> describeSourceRegions(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation
DescribeRegions
. For more information, see DescribeRegions in the Amazon EC2 API Reference.
This is a convenience which creates an instance of the
DescribeSourceRegionsRequest.Builder
avoiding the need to create one manually viaDescribeSourceRegionsRequest.builder()
- Parameters:
describeSourceRegionsRequest
- AConsumer
that will call methods onDescribeSourceRegionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSourceRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegions
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation
DescribeRegions
. For more information, see DescribeRegions in the Amazon EC2 API Reference.- Returns:
- A Java Future containing the result of the DescribeSourceRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegionsPaginator
This is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response) { //... }; });
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
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegionsPaginator
default DescribeSourceRegionsPublisher describeSourceRegionsPaginator(DescribeSourceRegionsRequest describeSourceRegionsRequest) This is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response) { //... }; });
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
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.- Parameters:
describeSourceRegionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSourceRegionsPaginator
default DescribeSourceRegionsPublisher describeSourceRegionsPaginator(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) This is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsPublisher publisher = client.describeSourceRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response) { //... }; });
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
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSourceRegionsRequest.Builder
avoiding the need to create one manually viaDescribeSourceRegionsRequest.builder()
- Parameters:
describeSourceRegionsRequest
- AConsumer
that will call methods onDescribeSourceRegionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTenantDatabases
default CompletableFuture<DescribeTenantDatabasesResponse> describeTenantDatabases(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
- Parameters:
describeTenantDatabasesRequest
-- Returns:
- A Java Future containing the result of the DescribeTenantDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeTenantDatabases
default CompletableFuture<DescribeTenantDatabasesResponse> describeTenantDatabases(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
This is a convenience which creates an instance of the
DescribeTenantDatabasesRequest.Builder
avoiding the need to create one manually viaDescribeTenantDatabasesRequest.builder()
- Parameters:
describeTenantDatabasesRequest
- AConsumer
that will call methods onDescribeTenantDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTenantDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeTenantDatabasesPaginator
default DescribeTenantDatabasesPublisher describeTenantDatabasesPaginator(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) This is a variant of
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesPublisher publisher = client.describeTenantDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesPublisher publisher = client.describeTenantDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse response) { //... }; });
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
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.- Parameters:
describeTenantDatabasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeTenantDatabasesPaginator
default DescribeTenantDatabasesPublisher describeTenantDatabasesPaginator(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) This is a variant of
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesPublisher publisher = client.describeTenantDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesPublisher publisher = client.describeTenantDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse response) { //... }; });
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
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.
This is a convenience which creates an instance of the
DescribeTenantDatabasesRequest.Builder
avoiding the need to create one manually viaDescribeTenantDatabasesRequest.builder()
- Parameters:
describeTenantDatabasesRequest
- AConsumer
that will call methods onDescribeTenantDatabasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeValidDBInstanceModifications
default CompletableFuture<DescribeValidDbInstanceModificationsResponse> describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) You can call
DescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance. You can use this information when you callModifyDBInstance
.This command doesn't apply to RDS Custom.
- Parameters:
describeValidDbInstanceModificationsRequest
-- Returns:
- A Java Future containing the result of the DescribeValidDBInstanceModifications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
describeValidDBInstanceModifications
default CompletableFuture<DescribeValidDbInstanceModificationsResponse> describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) You can call
DescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance. You can use this information when you callModifyDBInstance
.This command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
DescribeValidDbInstanceModificationsRequest.Builder
avoiding the need to create one manually viaDescribeValidDbInstanceModificationsRequest.builder()
- Parameters:
describeValidDbInstanceModificationsRequest
- AConsumer
that will call methods onDescribeValidDbInstanceModificationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeValidDBInstanceModifications operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
disableHttpEndpoint
default CompletableFuture<DisableHttpEndpointResponse> disableHttpEndpoint(DisableHttpEndpointRequest disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the
EnableHttpEndpoint
parameter of theModifyDBCluster
operation.- Parameters:
disableHttpEndpointRequest
-- Returns:
- A Java Future containing the result of the DisableHttpEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidResourceStateException The operation can't be performed because another operation is in progress.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableHttpEndpoint
default CompletableFuture<DisableHttpEndpointResponse> disableHttpEndpoint(Consumer<DisableHttpEndpointRequest.Builder> disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the
EnableHttpEndpoint
parameter of theModifyDBCluster
operation.
This is a convenience which creates an instance of the
DisableHttpEndpointRequest.Builder
avoiding the need to create one manually viaDisableHttpEndpointRequest.builder()
- Parameters:
disableHttpEndpointRequest
- AConsumer
that will call methods onDisableHttpEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableHttpEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidResourceStateException The operation can't be performed because another operation is in progress.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
downloadDBLogFilePortion
default CompletableFuture<DownloadDbLogFilePortionResponse> downloadDBLogFilePortion(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
- Parameters:
downloadDbLogFilePortionRequest
-- Returns:
- A Java Future containing the result of the DownloadDBLogFilePortion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbLogFileNotFoundException
LogFileName
doesn't refer to an existing DB log file. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
downloadDBLogFilePortion
default CompletableFuture<DownloadDbLogFilePortionResponse> downloadDBLogFilePortion(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
DownloadDbLogFilePortionRequest.Builder
avoiding the need to create one manually viaDownloadDbLogFilePortionRequest.builder()
- Parameters:
downloadDbLogFilePortionRequest
- AConsumer
that will call methods onDownloadDbLogFilePortionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DownloadDBLogFilePortion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbLogFileNotFoundException
LogFileName
doesn't refer to an existing DB log file. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
downloadDBLogFilePortionPaginator
default DownloadDBLogFilePortionPublisher downloadDBLogFilePortionPaginator(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) This is a variant of
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionPublisher publisher = client.downloadDBLogFilePortionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionPublisher publisher = client.downloadDBLogFilePortionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse response) { //... }; });
Please notice that the configuration of NumberOfLines 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
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.- Parameters:
downloadDbLogFilePortionRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbLogFileNotFoundException
LogFileName
doesn't refer to an existing DB log file. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
downloadDBLogFilePortionPaginator
default DownloadDBLogFilePortionPublisher downloadDBLogFilePortionPaginator(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) This is a variant of
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionPublisher publisher = client.downloadDBLogFilePortionPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionPublisher publisher = client.downloadDBLogFilePortionPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse response) { //... }; });
Please notice that the configuration of NumberOfLines 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
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.
This is a convenience which creates an instance of the
DownloadDbLogFilePortionRequest.Builder
avoiding the need to create one manually viaDownloadDbLogFilePortionRequest.builder()
- Parameters:
downloadDbLogFilePortionRequest
- AConsumer
that will call methods onDownloadDbLogFilePortionRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbLogFileNotFoundException
LogFileName
doesn't refer to an existing DB log file. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
enableHttpEndpoint
default CompletableFuture<EnableHttpEndpointResponse> enableHttpEndpoint(EnableHttpEndpointRequest enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the
EnableHttpEndpoint
parameter of theModifyDBCluster
operation.- Parameters:
enableHttpEndpointRequest
-- Returns:
- A Java Future containing the result of the EnableHttpEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidResourceStateException The operation can't be performed because another operation is in progress.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableHttpEndpoint
default CompletableFuture<EnableHttpEndpointResponse> enableHttpEndpoint(Consumer<EnableHttpEndpointRequest.Builder> enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the
EnableHttpEndpoint
parameter of theModifyDBCluster
operation.
This is a convenience which creates an instance of the
EnableHttpEndpointRequest.Builder
avoiding the need to create one manually viaEnableHttpEndpointRequest.builder()
- Parameters:
enableHttpEndpointRequest
- AConsumer
that will call methods onEnableHttpEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableHttpEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource ID was not found.
- InvalidResourceStateException The operation can't be performed because another operation is in progress.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
failoverDBCluster
default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
failoverDbClusterRequest
-- Returns:
- A Java Future containing the result of the FailoverDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
failoverDBCluster
default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
FailoverDbClusterRequest.Builder
avoiding the need to create one manually viaFailoverDbClusterRequest.builder()
- Parameters:
failoverDbClusterRequest
- AConsumer
that will call methods onFailoverDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
failoverGlobalCluster
default CompletableFuture<FailoverGlobalClusterResponse> failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
-
Failing over - Specify the
AllowDataLoss
parameter and don't specify theSwitchover
parameter. -
Switching over - Specify the
Switchover
parameter or omit it, but don't specify theAllowDataLoss
parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
-
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
-
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
- Parameters:
failoverGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the FailoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
-
failoverGlobalCluster
default CompletableFuture<FailoverGlobalClusterResponse> failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
-
Failing over - Specify the
AllowDataLoss
parameter and don't specify theSwitchover
parameter. -
Switching over - Specify the
Switchover
parameter or omit it, but don't specify theAllowDataLoss
parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
-
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
-
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
FailoverGlobalClusterRequest.Builder
avoiding the need to create one manually viaFailoverGlobalClusterRequest.builder()
- Parameters:
failoverGlobalClusterRequest
- AConsumer
that will call methods onFailoverGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
modifyActivityStream
default CompletableFuture<ModifyActivityStreamResponse> modifyActivityStream(ModifyActivityStreamRequest modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
- Parameters:
modifyActivityStreamRequest
-- Returns:
- A Java Future containing the result of the ModifyActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- ResourceNotFoundException The specified resource ID was not found.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyActivityStream
default CompletableFuture<ModifyActivityStreamResponse> modifyActivityStream(Consumer<ModifyActivityStreamRequest.Builder> modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
This is a convenience which creates an instance of the
ModifyActivityStreamRequest.Builder
avoiding the need to create one manually viaModifyActivityStreamRequest.builder()
- Parameters:
modifyActivityStreamRequest
- AConsumer
that will call methods onModifyActivityStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- ResourceNotFoundException The specified resource ID was not found.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCertificates
default CompletableFuture<ModifyCertificatesResponse> modifyCertificates(ModifyCertificatesRequest modifyCertificatesRequest) Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
-
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
-
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
- Parameters:
modifyCertificatesRequest
-- Returns:
- A Java Future containing the result of the ModifyCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
-
modifyCertificates
default CompletableFuture<ModifyCertificatesResponse> modifyCertificates(Consumer<ModifyCertificatesRequest.Builder> modifyCertificatesRequest) Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
-
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
-
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
ModifyCertificatesRequest.Builder
avoiding the need to create one manually viaModifyCertificatesRequest.builder()
- Parameters:
modifyCertificatesRequest
- AConsumer
that will call methods onModifyCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CertificateNotFoundException
- See Also:
-
-
modifyCurrentDBClusterCapacity
default CompletableFuture<ModifyCurrentDbClusterCapacityResponse> modifyCurrentDBClusterCapacity(ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest) Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call
ModifyCurrentDBClusterCapacity
to set the capacity explicitly.After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call
ModifyCurrentDBClusterCapacity
with the defaultTimeoutAction
, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.This operation only applies to Aurora Serverless v1 DB clusters.
- Parameters:
modifyCurrentDbClusterCapacityRequest
-- Returns:
- A Java Future containing the result of the ModifyCurrentDBClusterCapacity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterCapacityException
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are2
,4
,8
,16
,32
,64
,128
, and256
. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
modifyCurrentDBClusterCapacity
default CompletableFuture<ModifyCurrentDbClusterCapacityResponse> modifyCurrentDBClusterCapacity(Consumer<ModifyCurrentDbClusterCapacityRequest.Builder> modifyCurrentDbClusterCapacityRequest) Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call
ModifyCurrentDBClusterCapacity
to set the capacity explicitly.After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call
ModifyCurrentDBClusterCapacity
with the defaultTimeoutAction
, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.This operation only applies to Aurora Serverless v1 DB clusters.
This is a convenience which creates an instance of the
ModifyCurrentDbClusterCapacityRequest.Builder
avoiding the need to create one manually viaModifyCurrentDbClusterCapacityRequest.builder()
- Parameters:
modifyCurrentDbClusterCapacityRequest
- AConsumer
that will call methods onModifyCurrentDbClusterCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCurrentDBClusterCapacity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterCapacityException
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are2
,4
,8
,16
,32
,64
,128
, and256
. - 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
modifyCustomDBEngineVersion
default CompletableFuture<ModifyCustomDbEngineVersionResponse> modifyCustomDBEngineVersion(ModifyCustomDbEngineVersionRequest modifyCustomDbEngineVersionRequest) Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
DescribeDBEngineVersions
.The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for theModifyCustomDbEngineVersion
event.For more information, see Modifying CEV status in the Amazon RDS User Guide.
- Parameters:
modifyCustomDbEngineVersionRequest
-- Returns:
- A Java Future containing the result of the ModifyCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionNotFoundException The specified CEV was not found.
- InvalidCustomDbEngineVersionStateException You can't delete the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCustomDBEngineVersion
default CompletableFuture<ModifyCustomDbEngineVersionResponse> modifyCustomDBEngineVersion(Consumer<ModifyCustomDbEngineVersionRequest.Builder> modifyCustomDbEngineVersionRequest) Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
DescribeDBEngineVersions
.The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for theModifyCustomDbEngineVersion
event.For more information, see Modifying CEV status in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
ModifyCustomDbEngineVersionRequest.Builder
avoiding the need to create one manually viaModifyCustomDbEngineVersionRequest.builder()
- Parameters:
modifyCustomDbEngineVersionRequest
- AConsumer
that will call methods onModifyCustomDbEngineVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCustomDBEngineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CustomDbEngineVersionNotFoundException The specified CEV was not found.
- InvalidCustomDbEngineVersionStateException You can't delete the CEV.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBCluster
default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
modifyDbClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - StorageTypeNotAvailableException The
aurora-iopt1
storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago. - OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
modifyDBCluster
default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
ModifyDbClusterRequest.Builder
avoiding the need to create one manually viaModifyDbClusterRequest.builder()
- Parameters:
modifyDbClusterRequest
- AConsumer
that will call methods onModifyDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - StorageTypeNotAvailableException The
aurora-iopt1
storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago. - OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
modifyDBClusterEndpoint
default CompletableFuture<ModifyDbClusterEndpointResponse> modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
- Parameters:
modifyDbClusterEndpointRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterEndpointStateException The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBClusterEndpoint
default CompletableFuture<ModifyDbClusterEndpointResponse> modifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
ModifyDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaModifyDbClusterEndpointRequest.builder()
- Parameters:
modifyDbClusterEndpointRequest
- AConsumer
that will call methods onModifyDbClusterEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbClusterEndpointStateException The requested operation can't be performed on the endpoint while the endpoint is in this state.
- DbClusterEndpointNotFoundException The specified custom endpoint doesn't exist.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBClusterParameterGroup
default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or theDescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
modifyDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
modifyDBClusterParameterGroup
default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or theDescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
ModifyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaModifyDbClusterParameterGroupRequest.builder()
- Parameters:
modifyDbClusterParameterGroupRequest
- AConsumer
that will call methods onModifyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
modifyDBClusterSnapshotAttribute
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.Don't add the
all
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the
restore
attribute.- Parameters:
modifyDbClusterSnapshotAttributeRequest
-- Returns:
- A Java Future containing the result of the ModifyDBClusterSnapshotAttribute operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
modifyDBClusterSnapshotAttribute
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.Don't add the
all
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the
restore
attribute.
This is a convenience which creates an instance of the
ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually viaModifyDbClusterSnapshotAttributeRequest.builder()
- Parameters:
modifyDbClusterSnapshotAttributeRequest
- AConsumer
that will call methods onModifyDbClusterSnapshotAttributeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBClusterSnapshotAttribute operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterSnapshotNotFoundException
- See Also:
-
modifyDBInstance
default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call
DescribeValidDBInstanceModifications
before you callModifyDBInstance
.- Parameters:
modifyDbInstanceRequest
-- Returns:
- A Java Future containing the result of the ModifyDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbUpgradeDependencyFailureException The DB upgrade failed because a resource the DB depends on can't be modified.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBInstance
default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call
DescribeValidDBInstanceModifications
before you callModifyDBInstance
.
This is a convenience which creates an instance of the
ModifyDbInstanceRequest.Builder
avoiding the need to create one manually viaModifyDbInstanceRequest.builder()
- Parameters:
modifyDbInstanceRequest
- AConsumer
that will call methods onModifyDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- DbUpgradeDependencyFailureException The DB upgrade failed because a resource the DB depends on can't be modified.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBParameterGroup
default CompletableFuture<ModifyDbParameterGroupResponse> modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
modifyDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
modifyDBParameterGroup
default CompletableFuture<ModifyDbParameterGroupResponse> modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
This is a convenience which creates an instance of the
ModifyDbParameterGroupRequest.Builder
avoiding the need to create one manually viaModifyDbParameterGroupRequest.builder()
- Parameters:
modifyDbParameterGroupRequest
- AConsumer
that will call methods onModifyDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbParameterGroupNotFoundException
- See Also:
-
modifyDBProxy
default CompletableFuture<ModifyDbProxyResponse> modifyDBProxy(ModifyDbProxyRequest modifyDbProxyRequest) Changes the settings for an existing DB proxy.
- Parameters:
modifyDbProxyRequest
-- Returns:
- A Java Future containing the result of the ModifyDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyAlreadyExistsException The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBProxy
default CompletableFuture<ModifyDbProxyResponse> modifyDBProxy(Consumer<ModifyDbProxyRequest.Builder> modifyDbProxyRequest) Changes the settings for an existing DB proxy.
This is a convenience which creates an instance of the
ModifyDbProxyRequest.Builder
avoiding the need to create one manually viaModifyDbProxyRequest.builder()
- Parameters:
modifyDbProxyRequest
- AConsumer
that will call methods onModifyDbProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyAlreadyExistsException The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBProxyEndpoint
default CompletableFuture<ModifyDbProxyEndpointResponse> modifyDBProxyEndpoint(ModifyDbProxyEndpointRequest modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.
- Parameters:
modifyDbProxyEndpointRequest
-- Returns:
- A Java Future containing the result of the ModifyDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't exist.
- DbProxyEndpointAlreadyExistsException The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyEndpointStateException You can't perform this operation while the DB proxy endpoint is in a particular state.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBProxyEndpoint
default CompletableFuture<ModifyDbProxyEndpointResponse> modifyDBProxyEndpoint(Consumer<ModifyDbProxyEndpointRequest.Builder> modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.
This is a convenience which creates an instance of the
ModifyDbProxyEndpointRequest.Builder
avoiding the need to create one manually viaModifyDbProxyEndpointRequest.builder()
- Parameters:
modifyDbProxyEndpointRequest
- AConsumer
that will call methods onModifyDbProxyEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBProxyEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyEndpointNotFoundException The DB proxy endpoint doesn't exist.
- DbProxyEndpointAlreadyExistsException The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyEndpointStateException You can't perform this operation while the DB proxy endpoint is in a particular state.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBProxyTargetGroup
default CompletableFuture<ModifyDbProxyTargetGroupResponse> modifyDBProxyTargetGroup(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest) Modifies the properties of a
DBProxyTargetGroup
.- Parameters:
modifyDbProxyTargetGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBProxyTargetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBProxyTargetGroup
default CompletableFuture<ModifyDbProxyTargetGroupResponse> modifyDBProxyTargetGroup(Consumer<ModifyDbProxyTargetGroupRequest.Builder> modifyDbProxyTargetGroupRequest) Modifies the properties of a
DBProxyTargetGroup
.
This is a convenience which creates an instance of the
ModifyDbProxyTargetGroupRequest.Builder
avoiding the need to create one manually viaModifyDbProxyTargetGroupRequest.builder()
- Parameters:
modifyDbProxyTargetGroupRequest
- AConsumer
that will call methods onModifyDbProxyTargetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBProxyTargetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBRecommendation
default CompletableFuture<ModifyDbRecommendationResponse> modifyDBRecommendation(ModifyDbRecommendationRequest modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.
- Parameters:
modifyDbRecommendationRequest
-- Returns:
- A Java Future containing the result of the ModifyDBRecommendation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBRecommendation
default CompletableFuture<ModifyDbRecommendationResponse> modifyDBRecommendation(Consumer<ModifyDbRecommendationRequest.Builder> modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.
This is a convenience which creates an instance of the
ModifyDbRecommendationRequest.Builder
avoiding the need to create one manually viaModifyDbRecommendationRequest.builder()
- Parameters:
modifyDbRecommendationRequest
- AConsumer
that will call methods onModifyDbRecommendationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBRecommendation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBShardGroup
default CompletableFuture<ModifyDbShardGroupResponse> modifyDBShardGroup(ModifyDbShardGroupRequest modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
- Parameters:
modifyDbShardGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbShardGroupAlreadyExistsException The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidMaxAcuException The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBShardGroup
default CompletableFuture<ModifyDbShardGroupResponse> modifyDBShardGroup(Consumer<ModifyDbShardGroupRequest.Builder> modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
This is a convenience which creates an instance of the
ModifyDbShardGroupRequest.Builder
avoiding the need to create one manually viaModifyDbShardGroupRequest.builder()
- Parameters:
modifyDbShardGroupRequest
- AConsumer
that will call methods onModifyDbShardGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbShardGroupAlreadyExistsException The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidMaxAcuException The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyDBSnapshot
default CompletableFuture<ModifyDbSnapshotResponse> modifyDBSnapshot(ModifyDbSnapshotRequest modifyDbSnapshotRequest) Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
- Parameters:
modifyDbSnapshotRequest
-- Returns:
- A Java Future containing the result of the ModifyDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
modifyDBSnapshot
default CompletableFuture<ModifyDbSnapshotResponse> modifyDBSnapshot(Consumer<ModifyDbSnapshotRequest.Builder> modifyDbSnapshotRequest) Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
This is a convenience which creates an instance of the
ModifyDbSnapshotRequest.Builder
avoiding the need to create one manually viaModifyDbSnapshotRequest.builder()
- Parameters:
modifyDbSnapshotRequest
- AConsumer
that will call methods onModifyDbSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
modifyDBSnapshotAttribute
default CompletableFuture<ModifyDbSnapshotAttributeResponse> modifyDBSnapshotAttribute(ModifyDbSnapshotAttributeRequest modifyDbSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the valueall
to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.Don't add the
all
value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the
restore
attribute.- Parameters:
modifyDbSnapshotAttributeRequest
-- Returns:
- A Java Future containing the result of the ModifyDBSnapshotAttribute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
modifyDBSnapshotAttribute
default CompletableFuture<ModifyDbSnapshotAttributeResponse> modifyDBSnapshotAttribute(Consumer<ModifyDbSnapshotAttributeRequest.Builder> modifyDbSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the valueall
to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.Don't add the
all
value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the
restore
attribute.
This is a convenience which creates an instance of the
ModifyDbSnapshotAttributeRequest.Builder
avoiding the need to create one manually viaModifyDbSnapshotAttributeRequest.builder()
- Parameters:
modifyDbSnapshotAttributeRequest
- AConsumer
that will call methods onModifyDbSnapshotAttributeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBSnapshotAttribute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
modifyDBSubnetGroup
default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
- Parameters:
modifyDbSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetQuotaExceededException The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- SubnetAlreadyInUseException The DB subnet is already in use in the Availability Zone.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
modifyDBSubnetGroup
default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
This is a convenience which creates an instance of the
ModifyDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()
- Parameters:
modifyDbSubnetGroupRequest
- AConsumer
that will call methods onModifyDbSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetQuotaExceededException The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
- SubnetAlreadyInUseException The DB subnet is already in use in the Availability Zone.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSubnetGroupNotFoundException
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the
AddSourceIdentifierToSubscription
andRemoveSourceIdentifierFromSubscription
calls.You can see a list of the event categories for a given source type (
SourceType
) in Events in the Amazon RDS User Guide or by using theDescribeEventCategories
operation.- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have reached the maximum number of event subscriptions.
- SubscriptionNotFoundException The subscription name does not exist.
- SnsInvalidTopicException SNS has responded that there is a problem with the SNS topic specified.
- SnsNoAuthorizationException You do not have permission to publish to the SNS topic ARN.
- SnsTopicArnNotFoundException The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundException The supplied 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyEventSubscription
default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the
AddSourceIdentifierToSubscription
andRemoveSourceIdentifierFromSubscription
calls.You can see a list of the event categories for a given source type (
SourceType
) in Events in the Amazon RDS User Guide or by using theDescribeEventCategories
operation.
This is a convenience which creates an instance of the
ModifyEventSubscriptionRequest.Builder
avoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyEventSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EventSubscriptionQuotaExceededException You have reached the maximum number of event subscriptions.
- SubscriptionNotFoundException The subscription name does not exist.
- SnsInvalidTopicException SNS has responded that there is a problem with the SNS topic specified.
- SnsNoAuthorizationException You do not have permission to publish to the SNS topic ARN.
- SnsTopicArnNotFoundException The SNS topic ARN does not exist.
- SubscriptionCategoryNotFoundException The supplied 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyGlobalCluster
default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
- Parameters:
modifyGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
modifyGlobalCluster
default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
This is a convenience which creates an instance of the
ModifyGlobalClusterRequest.Builder
avoiding the need to create one manually viaModifyGlobalClusterRequest.builder()
- Parameters:
modifyGlobalClusterRequest
- AConsumer
that will call methods onModifyGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
modifyIntegration
default CompletableFuture<ModifyIntegrationResponse> modifyIntegration(ModifyIntegrationRequest modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.
- Parameters:
modifyIntegrationRequest
-- Returns:
- A Java Future containing the result of the ModifyIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration could not be found.
- InvalidIntegrationStateException The integration is in an invalid state and can't perform the requested operation.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyIntegration
default CompletableFuture<ModifyIntegrationResponse> modifyIntegration(Consumer<ModifyIntegrationRequest.Builder> modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.
This is a convenience which creates an instance of the
ModifyIntegrationRequest.Builder
avoiding the need to create one manually viaModifyIntegrationRequest.builder()
- Parameters:
modifyIntegrationRequest
- AConsumer
that will call methods onModifyIntegrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyIntegration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- IntegrationNotFoundException The specified integration could not be found.
- InvalidIntegrationStateException The integration is in an invalid state and can't perform the requested operation.
- IntegrationConflictOperationException A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyOptionGroup
default CompletableFuture<ModifyOptionGroupResponse> modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) Modifies an existing option group.
- Parameters:
modifyOptionGroupRequest
-- Returns:
- A Java Future containing the result of the ModifyOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidOptionGroupStateException The option group isn't in the available state.
- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyOptionGroup
default CompletableFuture<ModifyOptionGroupResponse> modifyOptionGroup(Consumer<ModifyOptionGroupRequest.Builder> modifyOptionGroupRequest) Modifies an existing option group.
This is a convenience which creates an instance of the
ModifyOptionGroupRequest.Builder
avoiding the need to create one manually viaModifyOptionGroupRequest.builder()
- Parameters:
modifyOptionGroupRequest
- AConsumer
that will call methods onModifyOptionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyOptionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidOptionGroupStateException The option group isn't in the available state.
- OptionGroupNotFoundException The specified option group 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyTenantDatabase
default CompletableFuture<ModifyTenantDatabaseResponse> modifyTenantDatabase(ModifyTenantDatabaseRequest modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
- Parameters:
modifyTenantDatabaseRequest
-- Returns:
- A Java Future containing the result of the ModifyTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- TenantDatabaseAlreadyExistsException You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
modifyTenantDatabase
default CompletableFuture<ModifyTenantDatabaseResponse> modifyTenantDatabase(Consumer<ModifyTenantDatabaseRequest.Builder> modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
This is a convenience which creates an instance of the
ModifyTenantDatabaseRequest.Builder
avoiding the need to create one manually viaModifyTenantDatabaseRequest.builder()
- Parameters:
modifyTenantDatabaseRequest
- AConsumer
that will call methods onModifyTenantDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyTenantDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- TenantDatabaseAlreadyExistsException You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
promoteReadReplica
default CompletableFuture<PromoteReadReplicaResponse> promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest) Promotes a read replica DB instance to a standalone DB instance.
-
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the
backing-up
status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. -
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
- Parameters:
promoteReadReplicaRequest
-- Returns:
- A Java Future containing the result of the PromoteReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
promoteReadReplica
default CompletableFuture<PromoteReadReplicaResponse> promoteReadReplica(Consumer<PromoteReadReplicaRequest.Builder> promoteReadReplicaRequest) Promotes a read replica DB instance to a standalone DB instance.
-
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the
backing-up
status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. -
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
This is a convenience which creates an instance of the
PromoteReadReplicaRequest.Builder
avoiding the need to create one manually viaPromoteReadReplicaRequest.builder()
- Parameters:
promoteReadReplicaRequest
- AConsumer
that will call methods onPromoteReadReplicaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PromoteReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
promoteReadReplicaDBCluster
default CompletableFuture<PromoteReadReplicaDbClusterResponse> promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) Promotes a read replica DB cluster to a standalone DB cluster.
- Parameters:
promoteReadReplicaDbClusterRequest
-- Returns:
- A Java Future containing the result of the PromoteReadReplicaDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
promoteReadReplicaDBCluster
default CompletableFuture<PromoteReadReplicaDbClusterResponse> promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) Promotes a read replica DB cluster to a standalone DB cluster.
This is a convenience which creates an instance of the
PromoteReadReplicaDbClusterRequest.Builder
avoiding the need to create one manually viaPromoteReadReplicaDbClusterRequest.builder()
- Parameters:
promoteReadReplicaDbClusterRequest
- AConsumer
that will call methods onPromoteReadReplicaDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PromoteReadReplicaDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
purchaseReservedDBInstancesOffering
default CompletableFuture<PurchaseReservedDbInstancesOfferingResponse> purchaseReservedDBInstancesOffering(PurchaseReservedDbInstancesOfferingRequest purchaseReservedDbInstancesOfferingRequest) Purchases a reserved DB instance offering.
- Parameters:
purchaseReservedDbInstancesOfferingRequest
-- Returns:
- A Java Future containing the result of the PurchaseReservedDBInstancesOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering does not exist.
- ReservedDbInstanceAlreadyExistsException User already has a reservation with the given identifier.
- ReservedDbInstanceQuotaExceededException Request would exceed the user's DB Instance quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
purchaseReservedDBInstancesOffering
default CompletableFuture<PurchaseReservedDbInstancesOfferingResponse> purchaseReservedDBInstancesOffering(Consumer<PurchaseReservedDbInstancesOfferingRequest.Builder> purchaseReservedDbInstancesOfferingRequest) Purchases a reserved DB instance offering.
This is a convenience which creates an instance of the
PurchaseReservedDbInstancesOfferingRequest.Builder
avoiding the need to create one manually viaPurchaseReservedDbInstancesOfferingRequest.builder()
- Parameters:
purchaseReservedDbInstancesOfferingRequest
- AConsumer
that will call methods onPurchaseReservedDbInstancesOfferingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PurchaseReservedDBInstancesOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedDbInstancesOfferingNotFoundException Specified offering does not exist.
- ReservedDbInstanceAlreadyExistsException User already has a reservation with the given identifier.
- ReservedDbInstanceQuotaExceededException Request would exceed the user's DB Instance quota.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootDBCluster
default CompletableFuture<RebootDbClusterResponse> rebootDBCluster(RebootDbClusterRequest rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
rebootDbClusterRequest
-- Returns:
- A Java Future containing the result of the RebootDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
rebootDBCluster
default CompletableFuture<RebootDbClusterResponse> rebootDBCluster(Consumer<RebootDbClusterRequest.Builder> rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RebootDbClusterRequest.Builder
avoiding the need to create one manually viaRebootDbClusterRequest.builder()
- Parameters:
rebootDbClusterRequest
- AConsumer
that will call methods onRebootDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
rebootDBInstance
default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the
RebootDBCluster
operation.- Parameters:
rebootDbInstanceRequest
-- Returns:
- A Java Future containing the result of the RebootDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootDBInstance
default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the
RebootDBCluster
operation.
This is a convenience which creates an instance of the
RebootDbInstanceRequest.Builder
avoiding the need to create one manually viaRebootDbInstanceRequest.builder()
- Parameters:
rebootDbInstanceRequest
- AConsumer
that will call methods onRebootDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootDBShardGroup
default CompletableFuture<RebootDbShardGroupResponse> rebootDBShardGroup(RebootDbShardGroupRequest rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
- Parameters:
rebootDbShardGroupRequest
-- Returns:
- A Java Future containing the result of the RebootDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidDbShardGroupStateException The DB shard group must be 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootDBShardGroup
default CompletableFuture<RebootDbShardGroupResponse> rebootDBShardGroup(Consumer<RebootDbShardGroupRequest.Builder> rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
This is a convenience which creates an instance of the
RebootDbShardGroupRequest.Builder
avoiding the need to create one manually viaRebootDbShardGroupRequest.builder()
- Parameters:
rebootDbShardGroupRequest
- AConsumer
that will call methods onRebootDbShardGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootDBShardGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbShardGroupNotFoundException The specified DB shard group name wasn't found.
- InvalidDbShardGroupStateException The DB shard group must be 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerDBProxyTargets
default CompletableFuture<RegisterDbProxyTargetsResponse> registerDBProxyTargets(RegisterDbProxyTargetsRequest registerDbProxyTargetsRequest) Associate one or more
DBProxyTarget
data structures with aDBProxyTargetGroup
.- Parameters:
registerDbProxyTargetsRequest
-- Returns:
- A Java Future containing the result of the RegisterDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbProxyTargetAlreadyRegisteredException The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy is in this state.
- InsufficientAvailableIPsInSubnetException The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerDBProxyTargets
default CompletableFuture<RegisterDbProxyTargetsResponse> registerDBProxyTargets(Consumer<RegisterDbProxyTargetsRequest.Builder> registerDbProxyTargetsRequest) Associate one or more
DBProxyTarget
data structures with aDBProxyTargetGroup
.
This is a convenience which creates an instance of the
RegisterDbProxyTargetsRequest.Builder
avoiding the need to create one manually viaRegisterDbProxyTargetsRequest.builder()
- Parameters:
registerDbProxyTargetsRequest
- AConsumer
that will call methods onRegisterDbProxyTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterDBProxyTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbProxyTargetAlreadyRegisteredException The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbProxyStateException The requested operation can't be performed while the proxy is in this state.
- InsufficientAvailableIPsInSubnetException The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeFromGlobalCluster
default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
- Parameters:
removeFromGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the RemoveFromGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
removeFromGlobalCluster
default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
RemoveFromGlobalClusterRequest.Builder
avoiding the need to create one manually viaRemoveFromGlobalClusterRequest.builder()
- Parameters:
removeFromGlobalClusterRequest
- AConsumer
that will call methods onRemoveFromGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveFromGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
removeRoleFromDBCluster
default CompletableFuture<RemoveRoleFromDbClusterResponse> removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
removeRoleFromDbClusterRequest
-- Returns:
- A Java Future containing the result of the RemoveRoleFromDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterRoleNotFoundException The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
removeRoleFromDBCluster
default CompletableFuture<RemoveRoleFromDbClusterResponse> removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RemoveRoleFromDbClusterRequest.Builder
avoiding the need to create one manually viaRemoveRoleFromDbClusterRequest.builder()
- Parameters:
removeRoleFromDbClusterRequest
- AConsumer
that will call methods onRemoveRoleFromDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRoleFromDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterRoleNotFoundException The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
removeRoleFromDBInstance
default CompletableFuture<RemoveRoleFromDbInstanceResponse> removeRoleFromDBInstance(RemoveRoleFromDbInstanceRequest removeRoleFromDbInstanceRequest) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
- Parameters:
removeRoleFromDbInstanceRequest
-- Returns:
- A Java Future containing the result of the RemoveRoleFromDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbInstanceRoleNotFoundException The specified
RoleArn
value doesn't match the specified feature for the DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
removeRoleFromDBInstance
default CompletableFuture<RemoveRoleFromDbInstanceResponse> removeRoleFromDBInstance(Consumer<RemoveRoleFromDbInstanceRequest.Builder> removeRoleFromDbInstanceRequest) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
This is a convenience which creates an instance of the
RemoveRoleFromDbInstanceRequest.Builder
avoiding the need to create one manually viaRemoveRoleFromDbInstanceRequest.builder()
- Parameters:
removeRoleFromDbInstanceRequest
- AConsumer
that will call methods onRemoveRoleFromDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRoleFromDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbInstanceRoleNotFoundException The specified
RoleArn
value doesn't match the specified feature for the DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
removeSourceIdentifierFromSubscription
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeSourceIdentifierFromSubscription
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builder
avoiding the need to create one manually viaRemoveSourceIdentifierFromSubscriptionRequest.builder()
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
- AConsumer
that will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbProxyNotFoundException The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- DbProxyTargetGroupNotFoundException The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - IntegrationNotFoundException The specified integration could not be found.
- TenantDatabaseNotFoundException The specified tenant database wasn't found in the DB instance.
- DbSnapshotTenantDatabaseNotFoundException The specified snapshot tenant database wasn't 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
resetDBClusterParameterGroup
default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
parameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request. You must callRebootDBInstance
for every DB instance in your DB cluster that you want the updated static parameter to apply to.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
resetDbClusterParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetDBClusterParameterGroup
default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
parameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request. You must callRebootDBInstance
for every DB instance in your DB cluster that you want the updated static parameter to apply to.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
ResetDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbClusterParameterGroupRequest.builder()
- Parameters:
resetDbClusterParameterGroupRequest
- AConsumer
that will call methods onResetDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetDBClusterParameterGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetDBParameterGroup
default CompletableFuture<ResetDbParameterGroupResponse> resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Parameters:
resetDbParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetDBParameterGroup
default CompletableFuture<ResetDbParameterGroupResponse> resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.
This is a convenience which creates an instance of the
ResetDbParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbParameterGroupRequest.builder()
- Parameters:
resetDbParameterGroupRequest
- AConsumer
that will call methods onResetDbParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetDBParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbParameterGroupStateException The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterFromS3
default CompletableFuture<RestoreDbClusterFromS3Response> restoreDBClusterFromS3(RestoreDbClusterFromS3Request restoreDbClusterFromS3Request) Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterFromS3
operation has completed and the DB cluster is available.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
- Parameters:
restoreDbClusterFromS3Request
-- Returns:
- A Java Future containing the result of the RestoreDBClusterFromS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - InsufficientStorageClusterCapacityException There is insufficient 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.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterFromS3
default CompletableFuture<RestoreDbClusterFromS3Response> restoreDBClusterFromS3(Consumer<RestoreDbClusterFromS3Request.Builder> restoreDbClusterFromS3Request) Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterFromS3
operation has completed and the DB cluster is available.For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
This is a convenience which creates an instance of the
RestoreDbClusterFromS3Request.Builder
avoiding the need to create one manually viaRestoreDbClusterFromS3Request.builder()
- Parameters:
restoreDbClusterFromS3Request
- AConsumer
that will call methods onRestoreDbClusterFromS3Request.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBClusterFromS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - InsufficientStorageClusterCapacityException There is insufficient 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.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterFromSnapshot
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterFromSnapshot
operation has completed and the DB cluster is available.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
restoreDbClusterFromSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InsufficientDbClusterCapacityException The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient 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 DB snapshot doesn't allow deletion.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- OptionGroupNotFoundException The specified option group could not be found.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterFromSnapshot
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterFromSnapshot
operation has completed and the DB cluster is available.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RestoreDbClusterFromSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreDbClusterFromSnapshotRequest.builder()
- Parameters:
restoreDbClusterFromSnapshotRequest
- AConsumer
that will call methods onRestoreDbClusterFromSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - InsufficientDbClusterCapacityException The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient 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 DB snapshot doesn't allow deletion.
- InvalidDbClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- OptionGroupNotFoundException The specified option group could not be found.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterToPointInTime
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterToPointInTime
operation has completed and the DB cluster is available.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
- Parameters:
restoreDbClusterToPointInTimeRequest
-- Returns:
- A Java Future containing the result of the RestoreDBClusterToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InsufficientDbClusterCapacityException The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient 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 supplied value isn't a valid DB cluster snapshot state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was found.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBClusterToPointInTime
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster inDBClusterIdentifier
. You can create DB instances only after theRestoreDBClusterToPointInTime
operation has completed and the DB cluster is available.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RestoreDbClusterToPointInTimeRequest.Builder
avoiding the need to create one manually viaRestoreDbClusterToPointInTimeRequest.builder()
- Parameters:
restoreDbClusterToPointInTimeRequest
- AConsumer
that will call methods onRestoreDbClusterToPointInTimeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBClusterToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
- DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - InsufficientDbClusterCapacityException The DB cluster doesn't have enough capacity for the current operation.
- InsufficientStorageClusterCapacityException There is insufficient 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 supplied value isn't a valid DB cluster snapshot state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbClusterParameterGroupNotFoundException
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group. - DbClusterAutomatedBackupNotFoundException No automated backup for this DB cluster was found.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceFromDBSnapshot
default CompletableFuture<RestoreDbInstanceFromDbSnapshotResponse> restoreDBInstanceFromDBSnapshot(RestoreDbInstanceFromDbSnapshotRequest restoreDbInstanceFromDbSnapshotRequest) Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the
RestoreDBInstanceFromDBSnapshot
operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as theDBInstanceIdentifier
in the call to theRestoreDBInstanceFromDBSnapshot
operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterFromSnapshot
.- Parameters:
restoreDbInstanceFromDbSnapshotRequest
-- Returns:
- A Java Future containing the result of the RestoreDBInstanceFromDBSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceFromDBSnapshot
default CompletableFuture<RestoreDbInstanceFromDbSnapshotResponse> restoreDBInstanceFromDBSnapshot(Consumer<RestoreDbInstanceFromDbSnapshotRequest.Builder> restoreDbInstanceFromDbSnapshotRequest) Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the
RestoreDBInstanceFromDBSnapshot
operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as theDBInstanceIdentifier
in the call to theRestoreDBInstanceFromDBSnapshot
operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterFromSnapshot
.
This is a convenience which creates an instance of the
RestoreDbInstanceFromDbSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreDbInstanceFromDbSnapshotRequest.builder()
- Parameters:
restoreDbInstanceFromDbSnapshotRequest
- AConsumer
that will call methods onRestoreDbInstanceFromDbSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBInstanceFromDBSnapshot operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDbSnapshotStateException The state of the DB snapshot doesn't allow deletion.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - CertificateNotFoundException
CertificateIdentifier
doesn't refer to an existing certificate. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceFromS3
default CompletableFuture<RestoreDbInstanceFromS3Response> restoreDBInstanceFromS3(RestoreDbInstanceFromS3Request restoreDbInstanceFromS3Request) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn't apply to RDS Custom.
- Parameters:
restoreDbInstanceFromS3Request
-- Returns:
- A Java Future containing the result of the RestoreDBInstanceFromS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceFromS3
default CompletableFuture<RestoreDbInstanceFromS3Response> restoreDBInstanceFromS3(Consumer<RestoreDbInstanceFromS3Request.Builder> restoreDbInstanceFromS3Request) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn't apply to RDS Custom.
This is a convenience which creates an instance of the
RestoreDbInstanceFromS3Request.Builder
avoiding the need to create one manually viaRestoreDbInstanceFromS3Request.builder()
- Parameters:
restoreDbInstanceFromS3Request
- AConsumer
that will call methods onRestoreDbInstanceFromS3Request.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBInstanceFromS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceToPointInTime
default CompletableFuture<RestoreDbInstanceToPointInTimeResponse> restoreDBInstanceToPointInTime(RestoreDbInstanceToPointInTimeRequest restoreDbInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the
LatestRestorableTime
property. You can restore to a point up to the number of days specified by theBackupRetentionPeriod
property.The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterToPointInTime
.- Parameters:
restoreDbInstanceToPointInTimeRequest
-- Returns:
- A Java Future containing the result of the RestoreDBInstanceToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- PointInTimeRestoreNotEnabledException
SourceDBInstanceIdentifier
refers to a DB instance withBackupRetentionPeriod
equal to 0. - StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was found.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreDBInstanceToPointInTime
default CompletableFuture<RestoreDbInstanceToPointInTimeResponse> restoreDBInstanceToPointInTime(Consumer<RestoreDbInstanceToPointInTimeRequest.Builder> restoreDbInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the
LatestRestorableTime
property. You can restore to a point up to the number of days specified by theBackupRetentionPeriod
property.The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterToPointInTime
.
This is a convenience which creates an instance of the
RestoreDbInstanceToPointInTimeRequest.Builder
avoiding the need to create one manually viaRestoreDbInstanceToPointInTimeRequest.builder()
- Parameters:
restoreDbInstanceToPointInTimeRequest
- AConsumer
that will call methods onRestoreDbInstanceToPointInTimeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreDBInstanceToPointInTime operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceAlreadyExistsException The user already has a DB instance with the given identifier.
- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- PointInTimeRestoreNotEnabledException
SourceDBInstanceIdentifier
refers to a DB instance withBackupRetentionPeriod
equal to 0. - StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- ProvisionedIopsNotAvailableInAzException Provisioned IOPS not available in the specified Availability Zone.
- OptionGroupNotFoundException The specified option group could not be found.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB instance. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - DomainNotFoundException
Domain
doesn't refer to an existing Active Directory domain. - DbParameterGroupNotFoundException
DBParameterGroupName
doesn't refer to an existing DB parameter group. - DbInstanceAutomatedBackupNotFoundException No automated backup for this DB instance was found.
- NetworkTypeNotSupportedException The network type is invalid for the DB instance. Valid nework type
values are
IPV4
andDUAL
. - TenantDatabaseQuotaExceededException You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
- CertificateNotFoundException
CertificateIdentifier
doesn'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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokeDBSecurityGroupIngress
default CompletableFuture<RevokeDbSecurityGroupIngressResponse> revokeDBSecurityGroupIngress(RevokeDbSecurityGroupIngressRequest revokeDbSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
- Parameters:
revokeDbSecurityGroupIngressRequest
-- Returns:
- A Java Future containing the result of the RevokeDBSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
revokeDBSecurityGroupIngress
default CompletableFuture<RevokeDbSecurityGroupIngressResponse> revokeDBSecurityGroupIngress(Consumer<RevokeDbSecurityGroupIngressRequest.Builder> revokeDbSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
RevokeDbSecurityGroupIngressRequest.Builder
avoiding the need to create one manually viaRevokeDbSecurityGroupIngressRequest.builder()
- Parameters:
revokeDbSecurityGroupIngressRequest
- AConsumer
that will call methods onRevokeDbSecurityGroupIngressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RevokeDBSecurityGroupIngress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSecurityGroupNotFoundException
DBSecurityGroupName
doesn't refer to an existing DB security group. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- InvalidDbSecurityGroupStateException The state of the DB security group doesn't allow deletion.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSecurityGroupNotFoundException
- See Also:
-
startActivityStream
default CompletableFuture<StartActivityStreamResponse> startActivityStream(StartActivityStreamRequest startActivityStreamRequest) Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
- Parameters:
startActivityStreamRequest
-- Returns:
- A Java Future containing the result of the StartActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundException The specified resource ID was not found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startActivityStream
default CompletableFuture<StartActivityStreamResponse> startActivityStream(Consumer<StartActivityStreamRequest.Builder> startActivityStreamRequest) Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
StartActivityStreamRequest.Builder
avoiding the need to create one manually viaStartActivityStreamRequest.builder()
- Parameters:
startActivityStreamRequest
- AConsumer
that will call methods onStartActivityStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundException The specified resource ID was not found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDBCluster
default CompletableFuture<StartDbClusterResponse> startDBCluster(StartDbClusterRequest startDbClusterRequest) Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the
StopDBCluster
operation.For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
- Parameters:
startDbClusterRequest
-- Returns:
- A Java Future containing the result of the StartDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
startDBCluster
default CompletableFuture<StartDbClusterResponse> startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the
StopDBCluster
operation.For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
StartDbClusterRequest.Builder
avoiding the need to create one manually viaStartDbClusterRequest.builder()
- Parameters:
startDbClusterRequest
- AConsumer
that will call methods onStartDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
startDBInstance
default CompletableFuture<StartDbInstanceResponse> startDBInstance(StartDbInstanceRequest startDbInstanceRequest) Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the
StopDBInstance
operation.For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use
StartDBCluster
instead.- Parameters:
startDbInstanceRequest
-- Returns:
- A Java Future containing the result of the StartDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
startDBInstance
default CompletableFuture<StartDbInstanceResponse> startDBInstance(Consumer<StartDbInstanceRequest.Builder> startDbInstanceRequest) Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the
StopDBInstance
operation.For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use
StartDBCluster
instead.
This is a convenience which creates an instance of the
StartDbInstanceRequest.Builder
avoiding the need to create one manually viaStartDbInstanceRequest.builder()
- Parameters:
startDbInstanceRequest
- AConsumer
that will call methods onStartDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InsufficientDbInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
- DbSubnetGroupNotFoundException
DBSubnetGroupName
doesn't refer to an existing DB subnet group. - DbSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
- InvalidVpcNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - AuthorizationNotFoundException The specified CIDR IP range or Amazon EC2 security group might not be
authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
startDBInstanceAutomatedBackupsReplication
default CompletableFuture<StartDbInstanceAutomatedBackupsReplicationResponse> startDBInstanceAutomatedBackupsReplication(StartDbInstanceAutomatedBackupsReplicationRequest startDbInstanceAutomatedBackupsReplicationRequest) Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
- Parameters:
startDbInstanceAutomatedBackupsReplicationRequest
-- Returns:
- A Java Future containing the result of the StartDBInstanceAutomatedBackupsReplication operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbInstanceAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
startDBInstanceAutomatedBackupsReplication
default CompletableFuture<StartDbInstanceAutomatedBackupsReplicationResponse> startDBInstanceAutomatedBackupsReplication(Consumer<StartDbInstanceAutomatedBackupsReplicationRequest.Builder> startDbInstanceAutomatedBackupsReplicationRequest) Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
StartDbInstanceAutomatedBackupsReplicationRequest.Builder
avoiding the need to create one manually viaStartDbInstanceAutomatedBackupsReplicationRequest.builder()
- Parameters:
startDbInstanceAutomatedBackupsReplicationRequest
- AConsumer
that will call methods onStartDbInstanceAutomatedBackupsReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDBInstanceAutomatedBackupsReplication operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- DbInstanceAutomatedBackupQuotaExceededException The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
- StorageTypeNotSupportedException The specified
StorageType
can't be associated with the DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
startExportTask
default CompletableFuture<StartExportTaskResponse> startExportTask(StartExportTaskRequest startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from Db2 or RDS Custom DB instances.
You can't export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
- Parameters:
startExportTaskRequest
-- Returns:
- A Java Future containing the result of the StartExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - ExportTaskAlreadyExistsException You can't start an export task that's already running.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- IamRoleNotFoundException The IAM role is missing for exporting to an Amazon S3 bucket.
- IamRoleMissingPermissionsException The IAM role requires additional permissions to export to an Amazon S3 bucket.
- InvalidExportOnlyException The export is invalid for exporting to an Amazon S3 bucket.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- InvalidExportSourceStateException The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
startExportTask
default CompletableFuture<StartExportTaskResponse> startExportTask(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from Db2 or RDS Custom DB instances.
You can't export cluster data from Multi-AZ DB clusters.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
StartExportTaskRequest.Builder
avoiding the need to create one manually viaStartExportTaskRequest.builder()
- Parameters:
startExportTaskRequest
- AConsumer
that will call methods onStartExportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbSnapshotNotFoundException
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot. - DbClusterSnapshotNotFoundException
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot. - DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - ExportTaskAlreadyExistsException You can't start an export task that's already running.
- InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
- IamRoleNotFoundException The IAM role is missing for exporting to an Amazon S3 bucket.
- IamRoleMissingPermissionsException The IAM role requires additional permissions to export to an Amazon S3 bucket.
- InvalidExportOnlyException The export is invalid for exporting to an Amazon S3 bucket.
- KmsKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
- InvalidExportSourceStateException The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbSnapshotNotFoundException
- See Also:
-
stopActivityStream
default CompletableFuture<StopActivityStreamResponse> stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest) Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream
CLI command, or theStartActivityStream
operation.For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
- Parameters:
stopActivityStreamRequest
-- Returns:
- A Java Future containing the result of the StopActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundException The specified resource ID was not found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopActivityStream
default CompletableFuture<StopActivityStreamResponse> stopActivityStream(Consumer<StopActivityStreamRequest.Builder> stopActivityStreamRequest) Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream
CLI command, or theStartActivityStream
operation.For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
StopActivityStreamRequest.Builder
avoiding the need to create one manually viaStopActivityStreamRequest.builder()
- Parameters:
stopActivityStreamRequest
- AConsumer
that will call methods onStopActivityStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopActivityStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDbInstanceStateException The DB instance isn't in a valid state.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- ResourceNotFoundException The specified resource ID was not found.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDBCluster
default CompletableFuture<StopDbClusterResponse> stopDBCluster(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
- Parameters:
stopDbClusterRequest
-- Returns:
- A Java Future containing the result of the StopDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
stopDBCluster
default CompletableFuture<StopDbClusterResponse> stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
This is a convenience which creates an instance of the
StopDbClusterRequest.Builder
avoiding the need to create one manually viaStopDbClusterRequest.builder()
- Parameters:
stopDbClusterRequest
- AConsumer
that will call methods onStopDbClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDBCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB cluster. - InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbClusterNotFoundException
- See Also:
-
stopDBInstance
default CompletableFuture<StopDbInstanceResponse> stopDBInstance(StopDbInstanceRequest stopDbInstanceRequest) Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use
StopDBCluster
instead.- Parameters:
stopDbInstanceRequest
-- Returns:
- A Java Future containing the result of the StopDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
stopDBInstance
default CompletableFuture<StopDbInstanceResponse> stopDBInstance(Consumer<StopDbInstanceRequest.Builder> stopDbInstanceRequest) Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use
StopDBCluster
instead.
This is a convenience which creates an instance of the
StopDbInstanceRequest.Builder
avoiding the need to create one manually viaStopDbInstanceRequest.builder()
- Parameters:
stopDbInstanceRequest
- AConsumer
that will call methods onStopDbInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDBInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance isn't in a valid state.
- DbSnapshotAlreadyExistsException
DBSnapshotIdentifier
is already used by an existing snapshot. - SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.
- InvalidDbClusterStateException 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
stopDBInstanceAutomatedBackupsReplication
default CompletableFuture<StopDbInstanceAutomatedBackupsReplicationResponse> stopDBInstanceAutomatedBackupsReplication(StopDbInstanceAutomatedBackupsReplicationRequest stopDbInstanceAutomatedBackupsReplicationRequest) Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
- Parameters:
stopDbInstanceAutomatedBackupsReplicationRequest
-- Returns:
- A Java Future containing the result of the StopDBInstanceAutomatedBackupsReplication operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
stopDBInstanceAutomatedBackupsReplication
default CompletableFuture<StopDbInstanceAutomatedBackupsReplicationResponse> stopDBInstanceAutomatedBackupsReplication(Consumer<StopDbInstanceAutomatedBackupsReplicationRequest.Builder> stopDbInstanceAutomatedBackupsReplicationRequest) Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
This is a convenience which creates an instance of the
StopDbInstanceAutomatedBackupsReplicationRequest.Builder
avoiding the need to create one manually viaStopDbInstanceAutomatedBackupsReplicationRequest.builder()
- Parameters:
stopDbInstanceAutomatedBackupsReplicationRequest
- AConsumer
that will call methods onStopDbInstanceAutomatedBackupsReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDBInstanceAutomatedBackupsReplication operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
switchoverBlueGreenDeployment
default CompletableFuture<SwitchoverBlueGreenDeploymentResponse> switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest switchoverBlueGreenDeploymentRequest) Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Parameters:
switchoverBlueGreenDeploymentRequest
-- Returns:
- A Java Future containing the result of the SwitchoverBlueGreenDeployment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - InvalidBlueGreenDeploymentStateException The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
switchoverBlueGreenDeployment
default CompletableFuture<SwitchoverBlueGreenDeploymentResponse> switchoverBlueGreenDeployment(Consumer<SwitchoverBlueGreenDeploymentRequest.Builder> switchoverBlueGreenDeploymentRequest) Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
This is a convenience which creates an instance of the
SwitchoverBlueGreenDeploymentRequest.Builder
avoiding the need to create one manually viaSwitchoverBlueGreenDeploymentRequest.builder()
- Parameters:
switchoverBlueGreenDeploymentRequest
- AConsumer
that will call methods onSwitchoverBlueGreenDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SwitchoverBlueGreenDeployment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BlueGreenDeploymentNotFoundException
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment. - InvalidBlueGreenDeploymentStateException The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
- 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- BlueGreenDeploymentNotFoundException
- See Also:
-
switchoverGlobalCluster
default CompletableFuture<SwitchoverGlobalClusterResponse> switchoverGlobalCluster(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
- Parameters:
switchoverGlobalClusterRequest
-- Returns:
- A Java Future containing the result of the SwitchoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
switchoverGlobalCluster
default CompletableFuture<SwitchoverGlobalClusterResponse> switchoverGlobalCluster(Consumer<SwitchoverGlobalClusterRequest.Builder> switchoverGlobalClusterRequest) Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
This is a convenience which creates an instance of the
SwitchoverGlobalClusterRequest.Builder
avoiding the need to create one manually viaSwitchoverGlobalClusterRequest.builder()
- Parameters:
switchoverGlobalClusterRequest
- AConsumer
that will call methods onSwitchoverGlobalClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SwitchoverGlobalCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GlobalClusterNotFoundException The
GlobalClusterIdentifier
doesn't refer to an existing global database cluster. - InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.
- InvalidDbClusterStateException The requested operation can't be performed while the cluster is in this state.
- DbClusterNotFoundException
DBClusterIdentifier
doesn't refer to an existing DB 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- GlobalClusterNotFoundException The
- See Also:
-
switchoverReadReplica
default CompletableFuture<SwitchoverReadReplicaResponse> switchoverReadReplica(SwitchoverReadReplicaRequest switchoverReadReplicaRequest) Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
- Parameters:
switchoverReadReplicaRequest
-- Returns:
- A Java Future containing the result of the SwitchoverReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
switchoverReadReplica
default CompletableFuture<SwitchoverReadReplicaResponse> switchoverReadReplica(Consumer<SwitchoverReadReplicaRequest.Builder> switchoverReadReplicaRequest) Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
This is a convenience which creates an instance of the
SwitchoverReadReplicaRequest.Builder
avoiding the need to create one manually viaSwitchoverReadReplicaRequest.builder()
- Parameters:
switchoverReadReplicaRequest
- AConsumer
that will call methods onSwitchoverReadReplicaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SwitchoverReadReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DbInstanceNotFoundException
DBInstanceIdentifier
doesn't refer to an existing DB instance. - InvalidDbInstanceStateException The DB instance 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.
- RdsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- DbInstanceNotFoundException
- See Also:
-
waiter
Create an instance ofRdsAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
RdsAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aRdsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRdsAsyncClient
.
-