Interface RdsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 TypeMethodDescriptiondefault AddRoleToDbClusterResponse
addRoleToDBCluster
(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.default AddRoleToDbClusterResponse
addRoleToDBCluster
(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with a DB cluster.default AddRoleToDbInstanceResponse
addRoleToDBInstance
(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest) Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.default AddRoleToDbInstanceResponse
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.default AddTagsToResourceResponse
addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource.default AddTagsToResourceResponse
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.default BacktrackDbClusterResponse
backtrackDBCluster
(Consumer<BacktrackDbClusterRequest.Builder> backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.default BacktrackDbClusterResponse
backtrackDBCluster
(BacktrackDbClusterRequest backtrackDbClusterRequest) Backtracks a DB cluster to a specific time, without creating a new DB cluster.static RdsClientBuilder
builder()
Create a builder that can be used to configure and create aRdsClient
.default CancelExportTaskResponse
cancelExportTask
(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest) Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.default CancelExportTaskResponse
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.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.default CopyDbParameterGroupResponse
copyDBParameterGroup
(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) Copies the specified DB parameter group.default CopyDbParameterGroupResponse
copyDBParameterGroup
(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.default CopyDbSnapshotResponse
copyDBSnapshot
(Consumer<CopyDbSnapshotRequest.Builder> copyDbSnapshotRequest) Copies the specified DB snapshot.default CopyDbSnapshotResponse
copyDBSnapshot
(CopyDbSnapshotRequest copyDbSnapshotRequest) Copies the specified DB snapshot.default CopyOptionGroupResponse
copyOptionGroup
(Consumer<CopyOptionGroupRequest.Builder> copyOptionGroupRequest) Copies the specified option group.default CopyOptionGroupResponse
copyOptionGroup
(CopyOptionGroupRequest copyOptionGroupRequest) Copies the specified option group.static RdsClient
create()
Create aRdsClient
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 CreateDbClusterResponse
createDBCluster
(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.default CreateDbClusterResponse
createDBCluster
(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.default CreateDbClusterEndpointResponse
createDBClusterEndpoint
(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.default CreateDbClusterEndpointResponse
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.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.default CreateDbInstanceResponse
createDBInstance
(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.default CreateDbInstanceResponse
createDBInstance
(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.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.default CreateDbParameterGroupResponse
createDBParameterGroup
(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.default CreateDbParameterGroupResponse
createDBParameterGroup
(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.default CreateDbProxyResponse
createDBProxy
(Consumer<CreateDbProxyRequest.Builder> createDbProxyRequest) Creates a new DB proxy.default CreateDbProxyResponse
createDBProxy
(CreateDbProxyRequest createDbProxyRequest) Creates a new DB proxy.default CreateDbProxyEndpointResponse
createDBProxyEndpoint
(Consumer<CreateDbProxyEndpointRequest.Builder> createDbProxyEndpointRequest) Creates aDBProxyEndpoint
.default CreateDbProxyEndpointResponse
createDBProxyEndpoint
(CreateDbProxyEndpointRequest createDbProxyEndpointRequest) Creates aDBProxyEndpoint
.default CreateDbSecurityGroupResponse
createDBSecurityGroup
(Consumer<CreateDbSecurityGroupRequest.Builder> createDbSecurityGroupRequest) Creates a new DB security group.default CreateDbSecurityGroupResponse
createDBSecurityGroup
(CreateDbSecurityGroupRequest createDbSecurityGroupRequest) Creates a new DB security group.default CreateDbShardGroupResponse
createDBShardGroup
(Consumer<CreateDbShardGroupRequest.Builder> createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database.default CreateDbShardGroupResponse
createDBShardGroup
(CreateDbShardGroupRequest createDbShardGroupRequest) Creates a new DB shard group for Aurora Limitless Database.default CreateDbSnapshotResponse
createDBSnapshot
(Consumer<CreateDbSnapshotRequest.Builder> createDbSnapshotRequest) Creates a snapshot of a DB instance.default CreateDbSnapshotResponse
createDBSnapshot
(CreateDbSnapshotRequest createDbSnapshotRequest) Creates a snapshot of a DB instance.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group.default CreateEventSubscriptionResponse
createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an RDS event notification subscription.default CreateEventSubscriptionResponse
createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an RDS event notification subscription.default CreateGlobalClusterResponse
createGlobalCluster
(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions.default CreateGlobalClusterResponse
createGlobalCluster
(CreateGlobalClusterRequest createGlobalClusterRequest) Creates an Aurora global database spread across multiple Amazon Web Services Regions.default CreateIntegrationResponse
createIntegration
(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.default CreateIntegrationResponse
createIntegration
(CreateIntegrationRequest createIntegrationRequest) Creates a zero-ETL integration with Amazon Redshift.default CreateOptionGroupResponse
createOptionGroup
(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest) Creates a new option group.default CreateOptionGroupResponse
createOptionGroup
(CreateOptionGroupRequest createOptionGroupRequest) Creates a new option group.default CreateTenantDatabaseResponse
createTenantDatabase
(Consumer<CreateTenantDatabaseRequest.Builder> createTenantDatabaseRequest) Creates a tenant database in a DB instance that uses the multi-tenant configuration.default CreateTenantDatabaseResponse
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 DeleteDbClusterResponse
deleteDBCluster
(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.default DeleteDbClusterResponse
deleteDBCluster
(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.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.default DeleteDbClusterEndpointResponse
deleteDBClusterEndpoint
(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.default DeleteDbClusterEndpointResponse
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.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.default DeleteDbInstanceResponse
deleteDBInstance
(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) Deletes a previously provisioned DB instance.default DeleteDbInstanceResponse
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.default DeleteDbParameterGroupResponse
deleteDBParameterGroup
(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) Deletes a specified DB parameter group.default DeleteDbParameterGroupResponse
deleteDBParameterGroup
(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DB parameter group.default DeleteDbProxyResponse
deleteDBProxy
(Consumer<DeleteDbProxyRequest.Builder> deleteDbProxyRequest) Deletes an existing DB proxy.default DeleteDbProxyResponse
deleteDBProxy
(DeleteDbProxyRequest deleteDbProxyRequest) Deletes an existing DB proxy.default DeleteDbProxyEndpointResponse
deleteDBProxyEndpoint
(Consumer<DeleteDbProxyEndpointRequest.Builder> deleteDbProxyEndpointRequest) Deletes aDBProxyEndpoint
.default DeleteDbProxyEndpointResponse
deleteDBProxyEndpoint
(DeleteDbProxyEndpointRequest deleteDbProxyEndpointRequest) Deletes aDBProxyEndpoint
.default DeleteDbSecurityGroupResponse
deleteDBSecurityGroup
(Consumer<DeleteDbSecurityGroupRequest.Builder> deleteDbSecurityGroupRequest) Deletes a DB security group.default DeleteDbSecurityGroupResponse
deleteDBSecurityGroup
(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest) Deletes a DB security group.default DeleteDbShardGroupResponse
deleteDBShardGroup
(Consumer<DeleteDbShardGroupRequest.Builder> deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.default DeleteDbShardGroupResponse
deleteDBShardGroup
(DeleteDbShardGroupRequest deleteDbShardGroupRequest) Deletes an Aurora Limitless Database DB shard group.default DeleteDbSnapshotResponse
deleteDBSnapshot
(Consumer<DeleteDbSnapshotRequest.Builder> deleteDbSnapshotRequest) Deletes a DB snapshot.default DeleteDbSnapshotResponse
deleteDBSnapshot
(DeleteDbSnapshotRequest deleteDbSnapshotRequest) Deletes a DB snapshot.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a DB subnet group.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.default DeleteEventSubscriptionResponse
deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.default DeleteEventSubscriptionResponse
deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.default DeleteGlobalClusterResponse
deleteGlobalCluster
(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database cluster.default DeleteGlobalClusterResponse
deleteGlobalCluster
(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database cluster.default DeleteIntegrationResponse
deleteIntegration
(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.default DeleteIntegrationResponse
deleteIntegration
(DeleteIntegrationRequest deleteIntegrationRequest) Deletes a zero-ETL integration with Amazon Redshift.default DeleteOptionGroupResponse
deleteOptionGroup
(Consumer<DeleteOptionGroupRequest.Builder> deleteOptionGroupRequest) Deletes an existing option group.default DeleteOptionGroupResponse
deleteOptionGroup
(DeleteOptionGroupRequest deleteOptionGroupRequest) Deletes an existing option group.default DeleteTenantDatabaseResponse
deleteTenantDatabase
(Consumer<DeleteTenantDatabaseRequest.Builder> deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance.default DeleteTenantDatabaseResponse
deleteTenantDatabase
(DeleteTenantDatabaseRequest deleteTenantDatabaseRequest) Deletes a tenant database from your DB instance.default DeregisterDbProxyTargetsResponse
deregisterDBProxyTargets
(Consumer<DeregisterDbProxyTargetsRequest.Builder> deregisterDbProxyTargetsRequest) Remove the association between one or moreDBProxyTarget
data structures and aDBProxyTargetGroup
.default DeregisterDbProxyTargetsResponse
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.default DescribeCertificatesResponse
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.default DescribeCertificatesResponse
describeCertificates
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.default DescribeCertificatesResponse
describeCertificates
(DescribeCertificatesRequest describeCertificatesRequest) Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.default DescribeCertificatesIterable
This is a variant ofdescribeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.default DescribeCertificatesIterable
describeCertificatesPaginator
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) This is a variant ofdescribeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.default DescribeCertificatesIterable
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.default DescribeDbClustersResponse
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.default DescribeDbClustersResponse
describeDBClusters
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.default DescribeDbClustersResponse
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 DescribeDBClustersIterable
This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(DescribeDbClustersRequest describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.default DescribeDbEngineVersionsResponse
Describes the properties of specific versions of DB engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Describes the properties of specific versions of DB engines.default DescribeDBEngineVersionsIterable
This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
describeDBEngineVersionsPaginator
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
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.default DescribeDbInstancesResponse
Describes provisioned RDS instances.default DescribeDbInstancesResponse
describeDBInstances
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Describes provisioned RDS instances.default DescribeDbInstancesResponse
describeDBInstances
(DescribeDbInstancesRequest describeDbInstancesRequest) Describes provisioned RDS instances.default DescribeDBInstancesIterable
This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.default DescribeDbLogFilesResponse
describeDBLogFiles
(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.default DescribeDbLogFilesResponse
describeDBLogFiles
(DescribeDbLogFilesRequest describeDbLogFilesRequest) Returns a list of DB log files for the DB instance.default DescribeDBLogFilesIterable
describeDBLogFilesPaginator
(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) This is a variant ofdescribeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.default DescribeDBLogFilesIterable
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.default DescribeDbParametersResponse
describeDBParameters
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDbParametersResponse
describeDBParameters
(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersIterable
describeDBParametersPaginator
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.default DescribeDBParametersIterable
describeDBParametersPaginator
(DescribeDbParametersRequest describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.default DescribeDbProxiesResponse
describeDBProxies
(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) Returns information about DB proxies.default DescribeDbProxiesResponse
describeDBProxies
(DescribeDbProxiesRequest describeDbProxiesRequest) Returns information about DB proxies.default DescribeDBProxiesIterable
describeDBProxiesPaginator
(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) This is a variant ofdescribeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.default DescribeDBProxiesIterable
describeDBProxiesPaginator
(DescribeDbProxiesRequest describeDbProxiesRequest) This is a variant ofdescribeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.default DescribeDbProxyEndpointsResponse
describeDBProxyEndpoints
(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.default DescribeDbProxyEndpointsResponse
describeDBProxyEndpoints
(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) Returns information about DB proxy endpoints.default DescribeDBProxyEndpointsIterable
describeDBProxyEndpointsPaginator
(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) This is a variant ofdescribeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.default DescribeDBProxyEndpointsIterable
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.default DescribeDbProxyTargetsResponse
describeDBProxyTargets
(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) Returns information aboutDBProxyTarget
objects.default DescribeDbProxyTargetsResponse
describeDBProxyTargets
(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) Returns information aboutDBProxyTarget
objects.default DescribeDBProxyTargetsIterable
describeDBProxyTargetsPaginator
(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) This is a variant ofdescribeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.default DescribeDBProxyTargetsIterable
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.default DescribeDbSecurityGroupsResponse
Returns a list ofDBSecurityGroup
descriptions.default DescribeDbSecurityGroupsResponse
describeDBSecurityGroups
(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) Returns a list ofDBSecurityGroup
descriptions.default DescribeDbSecurityGroupsResponse
describeDBSecurityGroups
(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) Returns a list ofDBSecurityGroup
descriptions.default DescribeDBSecurityGroupsIterable
This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.default DescribeDBSecurityGroupsIterable
describeDBSecurityGroupsPaginator
(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.default DescribeDBSecurityGroupsIterable
describeDBSecurityGroupsPaginator
(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) This is a variant ofdescribeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.default DescribeDbShardGroupsResponse
describeDBShardGroups
(Consumer<DescribeDbShardGroupsRequest.Builder> describeDbShardGroupsRequest) Describes existing Aurora Limitless Database DB shard groups.default DescribeDbShardGroupsResponse
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.default DescribeDbSnapshotsResponse
Returns information about DB snapshots.default DescribeDbSnapshotsResponse
describeDBSnapshots
(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) Returns information about DB snapshots.default DescribeDbSnapshotsResponse
describeDBSnapshots
(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) Returns information about DB snapshots.default DescribeDBSnapshotsIterable
This is a variant ofdescribeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.default DescribeDBSnapshotsIterable
describeDBSnapshotsPaginator
(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) This is a variant ofdescribeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.default DescribeDBSnapshotsIterable
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.default DescribeDbSubnetGroupsResponse
Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsIterable
This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
describeDBSubnetGroupsPaginator
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
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.default DescribeEventCategoriesResponse
Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventsResponse
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.default 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 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 DescribeEventsIterable
This is a variant ofdescribeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
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.default DescribeExportTasksResponse
describeExportTasks
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3.default DescribeExportTasksResponse
describeExportTasks
(DescribeExportTasksRequest describeExportTasksRequest) Returns information about a snapshot or cluster export to Amazon S3.default DescribeExportTasksIterable
describeExportTasksPaginator
(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.default DescribeExportTasksIterable
describeExportTasksPaginator
(DescribeExportTasksRequest describeExportTasksRequest) This is a variant ofdescribeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.default DescribeGlobalClustersResponse
Returns information about Aurora global database clusters.default DescribeGlobalClustersResponse
describeGlobalClusters
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Aurora global database clusters.default DescribeGlobalClustersResponse
describeGlobalClusters
(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Aurora global database clusters.default DescribeGlobalClustersIterable
This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.default DescribeIntegrationsResponse
describeIntegrations
(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.default DescribeIntegrationsResponse
describeIntegrations
(DescribeIntegrationsRequest describeIntegrationsRequest) Describe one or more zero-ETL integrations with Amazon Redshift.default DescribeIntegrationsIterable
describeIntegrationsPaginator
(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) This is a variant ofdescribeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.default DescribeIntegrationsIterable
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.default DescribeOptionGroupsResponse
Describes the available option groups.default DescribeOptionGroupsResponse
describeOptionGroups
(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) Describes the available option groups.default DescribeOptionGroupsResponse
describeOptionGroups
(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.default DescribeOptionGroupsIterable
This is a variant ofdescribeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.default DescribeOptionGroupsIterable
describeOptionGroupsPaginator
(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) This is a variant ofdescribeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.default DescribeOptionGroupsIterable
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.default DescribeSourceRegionsResponse
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 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.default 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.default DescribeSourceRegionsIterable
This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.default DescribeSourceRegionsIterable
describeSourceRegionsPaginator
(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.default DescribeSourceRegionsIterable
describeSourceRegionsPaginator
(DescribeSourceRegionsRequest describeSourceRegionsRequest) This is a variant ofdescribeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.default DescribeTenantDatabasesResponse
describeTenantDatabases
(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration.default DescribeTenantDatabasesResponse
describeTenantDatabases
(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) Describes the tenant databases in a DB instance that uses the multi-tenant configuration.default DescribeTenantDatabasesIterable
describeTenantDatabasesPaginator
(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) This is a variant ofdescribeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.default DescribeTenantDatabasesIterable
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.default DisableHttpEndpointResponse
disableHttpEndpoint
(Consumer<DisableHttpEndpointRequest.Builder> disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster.default DisableHttpEndpointResponse
disableHttpEndpoint
(DisableHttpEndpointRequest disableHttpEndpointRequest) Disables the HTTP endpoint for the specified DB cluster.default DownloadDbLogFilePortionResponse
downloadDBLogFilePortion
(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.default DownloadDbLogFilePortionResponse
downloadDBLogFilePortion
(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.default DownloadDBLogFilePortionIterable
downloadDBLogFilePortionPaginator
(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) This is a variant ofdownloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.default DownloadDBLogFilePortionIterable
downloadDBLogFilePortionPaginator
(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) This is a variant ofdownloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation.default EnableHttpEndpointResponse
enableHttpEndpoint
(Consumer<EnableHttpEndpointRequest.Builder> enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster.default EnableHttpEndpointResponse
enableHttpEndpoint
(EnableHttpEndpointRequest enableHttpEndpointRequest) Enables the HTTP endpoint for the DB cluster.default FailoverDbClusterResponse
failoverDBCluster
(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.default FailoverDbClusterResponse
failoverDBCluster
(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.default FailoverGlobalClusterResponse
failoverGlobalCluster
(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) 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.default 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.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.default ModifyActivityStreamResponse
modifyActivityStream
(Consumer<ModifyActivityStreamRequest.Builder> modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked.default ModifyActivityStreamResponse
modifyActivityStream
(ModifyActivityStreamRequest modifyActivityStreamRequest) Changes the audit policy state of a database activity stream to either locked (default) or unlocked.default 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.default 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.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 ModifyDbClusterResponse
modifyDBCluster
(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.default ModifyDbClusterResponse
modifyDBCluster
(ModifyDbClusterRequest modifyDbClusterRequest) Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.default ModifyDbClusterEndpointResponse
modifyDBClusterEndpoint
(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Aurora DB cluster.default ModifyDbClusterEndpointResponse
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.default ModifyDbInstanceResponse
modifyDBInstance
(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance.default ModifyDbInstanceResponse
modifyDBInstance
(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance.default ModifyDbParameterGroupResponse
modifyDBParameterGroup
(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.default ModifyDbParameterGroupResponse
modifyDBParameterGroup
(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.default ModifyDbProxyResponse
modifyDBProxy
(Consumer<ModifyDbProxyRequest.Builder> modifyDbProxyRequest) Changes the settings for an existing DB proxy.default ModifyDbProxyResponse
modifyDBProxy
(ModifyDbProxyRequest modifyDbProxyRequest) Changes the settings for an existing DB proxy.default ModifyDbProxyEndpointResponse
modifyDBProxyEndpoint
(Consumer<ModifyDbProxyEndpointRequest.Builder> modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.default ModifyDbProxyEndpointResponse
modifyDBProxyEndpoint
(ModifyDbProxyEndpointRequest modifyDbProxyEndpointRequest) Changes the settings for an existing DB proxy endpoint.default ModifyDbProxyTargetGroupResponse
modifyDBProxyTargetGroup
(Consumer<ModifyDbProxyTargetGroupRequest.Builder> modifyDbProxyTargetGroupRequest) Modifies the properties of aDBProxyTargetGroup
.default ModifyDbProxyTargetGroupResponse
modifyDBProxyTargetGroup
(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest) Modifies the properties of aDBProxyTargetGroup
.default ModifyDbRecommendationResponse
modifyDBRecommendation
(Consumer<ModifyDbRecommendationRequest.Builder> modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.default ModifyDbRecommendationResponse
modifyDBRecommendation
(ModifyDbRecommendationRequest modifyDbRecommendationRequest) Updates the recommendation status and recommended action status for the specified recommendation.default ModifyDbShardGroupResponse
modifyDBShardGroup
(Consumer<ModifyDbShardGroupRequest.Builder> modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group.default ModifyDbShardGroupResponse
modifyDBShardGroup
(ModifyDbShardGroupRequest modifyDbShardGroupRequest) Modifies the settings of an Aurora Limitless Database DB shard group.default ModifyDbSnapshotResponse
modifyDBSnapshot
(Consumer<ModifyDbSnapshotRequest.Builder> modifyDbSnapshotRequest) Updates a manual DB snapshot with a new engine version.default ModifyDbSnapshotResponse
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.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.default ModifyEventSubscriptionResponse
modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription.default ModifyEventSubscriptionResponse
modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription.default ModifyGlobalClusterResponse
modifyGlobalCluster
(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster.default ModifyGlobalClusterResponse
modifyGlobalCluster
(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modifies a setting for an Amazon Aurora global database cluster.default ModifyIntegrationResponse
modifyIntegration
(Consumer<ModifyIntegrationRequest.Builder> modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.default ModifyIntegrationResponse
modifyIntegration
(ModifyIntegrationRequest modifyIntegrationRequest) Modifies a zero-ETL integration with Amazon Redshift.default ModifyOptionGroupResponse
modifyOptionGroup
(Consumer<ModifyOptionGroupRequest.Builder> modifyOptionGroupRequest) Modifies an existing option group.default ModifyOptionGroupResponse
modifyOptionGroup
(ModifyOptionGroupRequest modifyOptionGroupRequest) Modifies an existing option group.default ModifyTenantDatabaseResponse
modifyTenantDatabase
(Consumer<ModifyTenantDatabaseRequest.Builder> modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance.default ModifyTenantDatabaseResponse
modifyTenantDatabase
(ModifyTenantDatabaseRequest modifyTenantDatabaseRequest) Modifies an existing tenant database in a DB instance.default PromoteReadReplicaResponse
promoteReadReplica
(Consumer<PromoteReadReplicaRequest.Builder> promoteReadReplicaRequest) Promotes a read replica DB instance to a standalone DB instance.default PromoteReadReplicaResponse
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 RebootDbClusterResponse
rebootDBCluster
(Consumer<RebootDbClusterRequest.Builder> rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons.default RebootDbClusterResponse
rebootDBCluster
(RebootDbClusterRequest rebootDbClusterRequest) You might need to reboot your DB cluster, usually for maintenance reasons.default RebootDbInstanceResponse
rebootDBInstance
(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.default RebootDbInstanceResponse
rebootDBInstance
(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.default RebootDbShardGroupResponse
rebootDBShardGroup
(Consumer<RebootDbShardGroupRequest.Builder> rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons.default RebootDbShardGroupResponse
rebootDBShardGroup
(RebootDbShardGroupRequest rebootDbShardGroupRequest) You might need to reboot your DB shard group, usually for maintenance reasons.default RegisterDbProxyTargetsResponse
registerDBProxyTargets
(Consumer<RegisterDbProxyTargetsRequest.Builder> registerDbProxyTargetsRequest) Associate one or moreDBProxyTarget
data structures with aDBProxyTargetGroup
.default RegisterDbProxyTargetsResponse
registerDBProxyTargets
(RegisterDbProxyTargetsRequest registerDbProxyTargetsRequest) Associate one or moreDBProxyTarget
data structures with aDBProxyTargetGroup
.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches an Aurora secondary cluster from an Aurora global database cluster.default RemoveRoleFromDbClusterResponse
removeRoleFromDBCluster
(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.default RemoveRoleFromDbClusterResponse
removeRoleFromDBCluster
(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.default RemoveRoleFromDbInstanceResponse
removeRoleFromDBInstance
(Consumer<RemoveRoleFromDbInstanceRequest.Builder> removeRoleFromDbInstanceRequest) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.default RemoveRoleFromDbInstanceResponse
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.default RemoveTagsFromResourceResponse
removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.default RemoveTagsFromResourceResponse
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.default ResetDbParameterGroupResponse
resetDBParameterGroup
(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.default ResetDbParameterGroupResponse
resetDBParameterGroup
(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.default RestoreDbClusterFromS3Response
restoreDBClusterFromS3
(Consumer<RestoreDbClusterFromS3Request.Builder> restoreDbClusterFromS3Request) Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.default RestoreDbClusterFromS3Response
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.default RestoreDbInstanceFromS3Response
restoreDBInstanceFromS3
(Consumer<RestoreDbInstanceFromS3Request.Builder> restoreDbInstanceFromS3Request) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.default RestoreDbInstanceFromS3Response
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., ClientOverrideConfigurationstatic ServiceMetadata
default StartActivityStreamResponse
startActivityStream
(Consumer<StartActivityStreamRequest.Builder> startActivityStreamRequest) Starts a database activity stream to monitor activity on the database.default StartActivityStreamResponse
startActivityStream
(StartActivityStreamRequest startActivityStreamRequest) Starts a database activity stream to monitor activity on the database.default 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 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 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 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 StartExportTaskResponse
startExportTask
(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3.default StartExportTaskResponse
startExportTask
(StartExportTaskRequest startExportTaskRequest) Starts an export of DB snapshot or DB cluster data to Amazon S3.default StopActivityStreamResponse
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.default StopActivityStreamResponse
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 StopDbClusterResponse
stopDBCluster
(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Aurora DB cluster.default StopDbClusterResponse
stopDBCluster
(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Aurora DB cluster.default StopDbInstanceResponse
stopDBInstance
(Consumer<StopDbInstanceRequest.Builder> stopDbInstanceRequest) Stops an Amazon RDS DB instance.default 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.default 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.default SwitchoverGlobalClusterResponse
switchoverGlobalCluster
(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.default SwitchoverReadReplicaResponse
switchoverReadReplica
(Consumer<SwitchoverReadReplicaRequest.Builder> switchoverReadReplicaRequest) Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.default SwitchoverReadReplicaResponse
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 RdsWaiter
waiter()
Create an instance ofRdsWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException Associates an Identity and Access Management (IAM) role with a DB cluster.
- Parameters:
addRoleToDbClusterRequest
-- Returns:
- Result of the AddRoleToDBCluster operation returned by the service.
- See Also:
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddRoleToDBCluster operation returned by the service.
- See Also:
-
addRoleToDBInstance
default AddRoleToDbInstanceResponse addRoleToDBInstance(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest) throws DbInstanceNotFoundException, DbInstanceRoleAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddRoleToDBInstance operation returned by the service.
- See Also:
-
addRoleToDBInstance
default AddRoleToDbInstanceResponse addRoleToDBInstance(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest) throws DbInstanceNotFoundException, DbInstanceRoleAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddRoleToDBInstance operation returned by the service.
- See Also:
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException Adds a source identifier to an existing RDS event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, DbSnapshotNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, DbSnapshotNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException Applies a pending maintenance action to a resource (for example, to a DB instance).
This is a convenience which creates an instance of the
ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()
- Parameters:
applyPendingMaintenanceActionRequest
- AConsumer
that will call methods onApplyPendingMaintenanceActionRequest.Builder
to create a request.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
authorizeDBSecurityGroupIngress
default AuthorizeDbSecurityGroupIngressResponse authorizeDBSecurityGroupIngress(AuthorizeDbSecurityGroupIngressRequest authorizeDbSecurityGroupIngressRequest) throws DbSecurityGroupNotFoundException, InvalidDbSecurityGroupStateException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
- See Also:
-
authorizeDBSecurityGroupIngress
default AuthorizeDbSecurityGroupIngressResponse authorizeDBSecurityGroupIngress(Consumer<AuthorizeDbSecurityGroupIngressRequest.Builder> authorizeDbSecurityGroupIngressRequest) throws DbSecurityGroupNotFoundException, InvalidDbSecurityGroupStateException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
- See Also:
-
backtrackDBCluster
default BacktrackDbClusterResponse backtrackDBCluster(BacktrackDbClusterRequest backtrackDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the BacktrackDBCluster operation returned by the service.
- See Also:
-
backtrackDBCluster
default BacktrackDbClusterResponse backtrackDBCluster(Consumer<BacktrackDbClusterRequest.Builder> backtrackDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the BacktrackDBCluster operation returned by the service.
- See Also:
-
cancelExportTask
default CancelExportTaskResponse cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws ExportTaskNotFoundException, InvalidExportTaskStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CancelExportTask operation returned by the service.
- See Also:
-
cancelExportTask
default CancelExportTaskResponse cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest) throws ExportTaskNotFoundException, InvalidExportTaskStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CancelExportTask operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBParameterGroup operation returned by the service.
- See Also:
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBParameterGroup operation returned by the service.
- See Also:
-
copyDBSnapshot
default CopyDbSnapshotResponse copyDBSnapshot(CopyDbSnapshotRequest copyDbSnapshotRequest) throws DbSnapshotAlreadyExistsException, DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, CustomAvailabilityZoneNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBSnapshot operation returned by the service.
- See Also:
-
copyDBSnapshot
default CopyDbSnapshotResponse copyDBSnapshot(Consumer<CopyDbSnapshotRequest.Builder> copyDbSnapshotRequest) throws DbSnapshotAlreadyExistsException, DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, CustomAvailabilityZoneNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyDBSnapshot operation returned by the service.
- See Also:
-
copyOptionGroup
default CopyOptionGroupResponse copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException Copies the specified option group.
- Parameters:
copyOptionGroupRequest
-- Returns:
- Result of the CopyOptionGroup operation returned by the service.
- See Also:
-
copyOptionGroup
default CopyOptionGroupResponse copyOptionGroup(Consumer<CopyOptionGroupRequest.Builder> copyOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CopyOptionGroup operation returned by the service.
- See Also:
-
createBlueGreenDeployment
default CreateBlueGreenDeploymentResponse createBlueGreenDeployment(CreateBlueGreenDeploymentRequest createBlueGreenDeploymentRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, SourceDatabaseNotSupportedException, SourceClusterNotSupportedException, BlueGreenDeploymentAlreadyExistsException, DbParameterGroupNotFoundException, DbClusterParameterGroupNotFoundException, InstanceQuotaExceededException, DbClusterQuotaExceededException, InvalidDbInstanceStateException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateBlueGreenDeployment operation returned by the service.
- See Also:
-
createBlueGreenDeployment
default CreateBlueGreenDeploymentResponse createBlueGreenDeployment(Consumer<CreateBlueGreenDeploymentRequest.Builder> createBlueGreenDeploymentRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, SourceDatabaseNotSupportedException, SourceClusterNotSupportedException, BlueGreenDeploymentAlreadyExistsException, DbParameterGroupNotFoundException, DbClusterParameterGroupNotFoundException, InstanceQuotaExceededException, DbClusterQuotaExceededException, InvalidDbInstanceStateException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateBlueGreenDeployment operation returned by the service.
- See Also:
-
createCustomDBEngineVersion
default CreateCustomDbEngineVersionResponse createCustomDBEngineVersion(CreateCustomDbEngineVersionRequest createCustomDbEngineVersionRequest) throws CustomDbEngineVersionAlreadyExistsException, CustomDbEngineVersionQuotaExceededException, Ec2ImagePropertiesNotSupportedException, KmsKeyNotAccessibleException, CreateCustomDbEngineVersionException, AwsServiceException, SdkClientException, RdsException Creates a custom DB engine version (CEV).
- Parameters:
createCustomDbEngineVersionRequest
-- Returns:
- Result of the CreateCustomDBEngineVersion operation returned by the service.
- See Also:
-
createCustomDBEngineVersion
default CreateCustomDbEngineVersionResponse createCustomDBEngineVersion(Consumer<CreateCustomDbEngineVersionRequest.Builder> createCustomDbEngineVersionRequest) throws CustomDbEngineVersionAlreadyExistsException, CustomDbEngineVersionQuotaExceededException, Ec2ImagePropertiesNotSupportedException, KmsKeyNotAccessibleException, CreateCustomDbEngineVersionException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateCustomDBEngineVersion operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientDbInstanceCapacityException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DomainNotFoundException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientDbInstanceCapacityException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DomainNotFoundException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- See Also:
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, NetworkTypeNotSupportedException, CertificateNotFoundException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, NetworkTypeNotSupportedException, CertificateNotFoundException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBInstanceReadReplica
default CreateDbInstanceReadReplicaResponse createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbInstanceNotFoundException, DbClusterNotFoundException, InvalidDbInstanceStateException, InvalidDbClusterStateException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbSubnetGroupNotAllowedException, InvalidDbSubnetGroupException, StorageTypeNotSupportedException, KmsKeyNotAccessibleException, DomainNotFoundException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBInstanceReadReplica operation returned by the service.
- See Also:
-
createDBInstanceReadReplica
default CreateDbInstanceReadReplicaResponse createDBInstanceReadReplica(Consumer<CreateDbInstanceReadReplicaRequest.Builder> createDbInstanceReadReplicaRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbInstanceNotFoundException, DbClusterNotFoundException, InvalidDbInstanceStateException, InvalidDbClusterStateException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbSubnetGroupNotAllowedException, InvalidDbSubnetGroupException, StorageTypeNotSupportedException, KmsKeyNotAccessibleException, DomainNotFoundException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBInstanceReadReplica operation returned by the service.
- See Also:
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBParameterGroup operation returned by the service.
- See Also:
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBParameterGroup operation returned by the service.
- See Also:
-
createDBProxy
default CreateDbProxyResponse createDBProxy(CreateDbProxyRequest createDbProxyRequest) throws InvalidSubnetException, DbProxyAlreadyExistsException, DbProxyQuotaExceededException, AwsServiceException, SdkClientException, RdsException Creates a new DB proxy.
- Parameters:
createDbProxyRequest
-- Returns:
- Result of the CreateDBProxy operation returned by the service.
- See Also:
-
createDBProxy
default CreateDbProxyResponse createDBProxy(Consumer<CreateDbProxyRequest.Builder> createDbProxyRequest) throws InvalidSubnetException, DbProxyAlreadyExistsException, DbProxyQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBProxy operation returned by the service.
- See Also:
-
createDBProxyEndpoint
default CreateDbProxyEndpointResponse createDBProxyEndpoint(CreateDbProxyEndpointRequest createDbProxyEndpointRequest) throws InvalidSubnetException, DbProxyNotFoundException, DbProxyEndpointAlreadyExistsException, DbProxyEndpointQuotaExceededException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBProxyEndpoint operation returned by the service.
- See Also:
-
createDBProxyEndpoint
default CreateDbProxyEndpointResponse createDBProxyEndpoint(Consumer<CreateDbProxyEndpointRequest.Builder> createDbProxyEndpointRequest) throws InvalidSubnetException, DbProxyNotFoundException, DbProxyEndpointAlreadyExistsException, DbProxyEndpointQuotaExceededException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBProxyEndpoint operation returned by the service.
- See Also:
-
createDBSecurityGroup
default CreateDbSecurityGroupResponse createDBSecurityGroup(CreateDbSecurityGroupRequest createDbSecurityGroupRequest) throws DbSecurityGroupAlreadyExistsException, DbSecurityGroupQuotaExceededException, DbSecurityGroupNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBSecurityGroup operation returned by the service.
- See Also:
-
createDBSecurityGroup
default CreateDbSecurityGroupResponse createDBSecurityGroup(Consumer<CreateDbSecurityGroupRequest.Builder> createDbSecurityGroupRequest) throws DbSecurityGroupAlreadyExistsException, DbSecurityGroupQuotaExceededException, DbSecurityGroupNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBSecurityGroup operation returned by the service.
- See Also:
-
createDBShardGroup
default CreateDbShardGroupResponse createDBShardGroup(CreateDbShardGroupRequest createDbShardGroupRequest) throws DbShardGroupAlreadyExistsException, DbClusterNotFoundException, MaxDbShardGroupLimitReachedException, InvalidDbClusterStateException, InvalidMaxAcuException, UnsupportedDbEngineVersionException, InvalidVpcNetworkStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBShardGroup operation returned by the service.
- See Also:
-
createDBShardGroup
default CreateDbShardGroupResponse createDBShardGroup(Consumer<CreateDbShardGroupRequest.Builder> createDbShardGroupRequest) throws DbShardGroupAlreadyExistsException, DbClusterNotFoundException, MaxDbShardGroupLimitReachedException, InvalidDbClusterStateException, InvalidMaxAcuException, UnsupportedDbEngineVersionException, InvalidVpcNetworkStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBShardGroup operation returned by the service.
- See Also:
-
createDBSnapshot
default CreateDbSnapshotResponse createDBSnapshot(CreateDbSnapshotRequest createDbSnapshotRequest) throws DbSnapshotAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceNotFoundException, SnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException Creates a snapshot of a DB instance. The source DB instance must be in the
available
orstorage-optimization
state.- Parameters:
createDbSnapshotRequest
-- Returns:
- Result of the CreateDBSnapshot operation returned by the service.
- See Also:
-
createDBSnapshot
default CreateDbSnapshotResponse createDBSnapshot(Consumer<CreateDbSnapshotRequest.Builder> createDbSnapshotRequest) throws DbSnapshotAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceNotFoundException, SnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBSnapshot operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateGlobalCluster operation returned by the service.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateGlobalCluster operation returned by the service.
- See Also:
-
createIntegration
default CreateIntegrationResponse createIntegration(CreateIntegrationRequest createIntegrationRequest) throws DbClusterNotFoundException, DbInstanceNotFoundException, IntegrationAlreadyExistsException, IntegrationQuotaExceededException, KmsKeyNotAccessibleException, IntegrationConflictOperationException, AwsServiceException, SdkClientException, RdsException Creates a zero-ETL integration with Amazon Redshift.
- Parameters:
createIntegrationRequest
-- Returns:
- Result of the CreateIntegration operation returned by the service.
- See Also:
-
createIntegration
default CreateIntegrationResponse createIntegration(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) throws DbClusterNotFoundException, DbInstanceNotFoundException, IntegrationAlreadyExistsException, IntegrationQuotaExceededException, KmsKeyNotAccessibleException, IntegrationConflictOperationException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateIntegration operation returned by the service.
- See Also:
-
createOptionGroup
default CreateOptionGroupResponse createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
- Parameters:
createOptionGroupRequest
-- Returns:
- Result of the CreateOptionGroup operation returned by the service.
- See Also:
-
createOptionGroup
default CreateOptionGroupResponse createOptionGroup(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateOptionGroup operation returned by the service.
- See Also:
-
createTenantDatabase
default CreateTenantDatabaseResponse createTenantDatabase(CreateTenantDatabaseRequest createTenantDatabaseRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, TenantDatabaseAlreadyExistsException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateTenantDatabase operation returned by the service.
- See Also:
-
createTenantDatabase
default CreateTenantDatabaseResponse createTenantDatabase(Consumer<CreateTenantDatabaseRequest.Builder> createTenantDatabaseRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, TenantDatabaseAlreadyExistsException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the CreateTenantDatabase operation returned by the service.
- See Also:
-
deleteBlueGreenDeployment
default DeleteBlueGreenDeploymentResponse deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest deleteBlueGreenDeploymentRequest) throws BlueGreenDeploymentNotFoundException, InvalidBlueGreenDeploymentStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteBlueGreenDeployment operation returned by the service.
- See Also:
-
deleteBlueGreenDeployment
default DeleteBlueGreenDeploymentResponse deleteBlueGreenDeployment(Consumer<DeleteBlueGreenDeploymentRequest.Builder> deleteBlueGreenDeploymentRequest) throws BlueGreenDeploymentNotFoundException, InvalidBlueGreenDeploymentStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteBlueGreenDeployment operation returned by the service.
- See Also:
-
deleteCustomDBEngineVersion
default DeleteCustomDbEngineVersionResponse deleteCustomDBEngineVersion(DeleteCustomDbEngineVersionRequest deleteCustomDbEngineVersionRequest) throws CustomDbEngineVersionNotFoundException, InvalidCustomDbEngineVersionStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteCustomDBEngineVersion operation returned by the service.
- See Also:
-
-
deleteCustomDBEngineVersion
default DeleteCustomDbEngineVersionResponse deleteCustomDBEngineVersion(Consumer<DeleteCustomDbEngineVersionRequest.Builder> deleteCustomDbEngineVersionRequest) throws CustomDbEngineVersionNotFoundException, InvalidCustomDbEngineVersionStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteCustomDBEngineVersion operation returned by the service.
- See Also:
-
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, DbClusterAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, DbClusterAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBClusterAutomatedBackup
default DeleteDbClusterAutomatedBackupResponse deleteDBClusterAutomatedBackup(DeleteDbClusterAutomatedBackupRequest deleteDbClusterAutomatedBackupRequest) throws InvalidDbClusterAutomatedBackupStateException, DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterAutomatedBackup operation returned by the service.
- See Also:
-
deleteDBClusterAutomatedBackup
default DeleteDbClusterAutomatedBackupResponse deleteDBClusterAutomatedBackup(Consumer<DeleteDbClusterAutomatedBackupRequest.Builder> deleteDbClusterAutomatedBackupRequest) throws InvalidDbClusterAutomatedBackupStateException, DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterAutomatedBackup operation returned by the service.
- See Also:
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Parameters:
deleteDbClusterEndpointRequest
-- Returns:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- See Also:
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBInstance operation returned by the service.
- See Also:
-
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBInstance operation returned by the service.
- See Also:
-
-
deleteDBInstanceAutomatedBackup
default DeleteDbInstanceAutomatedBackupResponse deleteDBInstanceAutomatedBackup(DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest) throws InvalidDbInstanceAutomatedBackupStateException, DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBInstanceAutomatedBackup operation returned by the service.
- See Also:
-
deleteDBInstanceAutomatedBackup
default DeleteDbInstanceAutomatedBackupResponse deleteDBInstanceAutomatedBackup(Consumer<DeleteDbInstanceAutomatedBackupRequest.Builder> deleteDbInstanceAutomatedBackupRequest) throws InvalidDbInstanceAutomatedBackupStateException, DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBInstanceAutomatedBackup operation returned by the service.
- See Also:
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
- Parameters:
deleteDbParameterGroupRequest
-- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- See Also:
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBParameterGroup operation returned by the service.
- See Also:
-
deleteDBProxy
default DeleteDbProxyResponse deleteDBProxy(DeleteDbProxyRequest deleteDbProxyRequest) throws DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Deletes an existing DB proxy.
- Parameters:
deleteDbProxyRequest
-- Returns:
- Result of the DeleteDBProxy operation returned by the service.
- See Also:
-
deleteDBProxy
default DeleteDbProxyResponse deleteDBProxy(Consumer<DeleteDbProxyRequest.Builder> deleteDbProxyRequest) throws DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBProxy operation returned by the service.
- See Also:
-
deleteDBProxyEndpoint
default DeleteDbProxyEndpointResponse deleteDBProxyEndpoint(DeleteDbProxyEndpointRequest deleteDbProxyEndpointRequest) throws DbProxyEndpointNotFoundException, InvalidDbProxyEndpointStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBProxyEndpoint operation returned by the service.
- See Also:
-
deleteDBProxyEndpoint
default DeleteDbProxyEndpointResponse deleteDBProxyEndpoint(Consumer<DeleteDbProxyEndpointRequest.Builder> deleteDbProxyEndpointRequest) throws DbProxyEndpointNotFoundException, InvalidDbProxyEndpointStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBProxyEndpoint operation returned by the service.
- See Also:
-
deleteDBSecurityGroup
default DeleteDbSecurityGroupResponse deleteDBSecurityGroup(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest) throws InvalidDbSecurityGroupStateException, DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBSecurityGroup operation returned by the service.
- See Also:
-
deleteDBSecurityGroup
default DeleteDbSecurityGroupResponse deleteDBSecurityGroup(Consumer<DeleteDbSecurityGroupRequest.Builder> deleteDbSecurityGroupRequest) throws InvalidDbSecurityGroupStateException, DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBSecurityGroup operation returned by the service.
- See Also:
-
deleteDBShardGroup
default DeleteDbShardGroupResponse deleteDBShardGroup(DeleteDbShardGroupRequest deleteDbShardGroupRequest) throws DbShardGroupNotFoundException, InvalidDbShardGroupStateException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException Deletes an Aurora Limitless Database DB shard group.
- Parameters:
deleteDbShardGroupRequest
-- Returns:
- Result of the DeleteDBShardGroup operation returned by the service.
- See Also:
-
deleteDBShardGroup
default DeleteDbShardGroupResponse deleteDBShardGroup(Consumer<DeleteDbShardGroupRequest.Builder> deleteDbShardGroupRequest) throws DbShardGroupNotFoundException, InvalidDbShardGroupStateException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBShardGroup operation returned by the service.
- See Also:
-
deleteDBSnapshot
default DeleteDbSnapshotResponse deleteDBSnapshot(DeleteDbSnapshotRequest deleteDbSnapshotRequest) throws InvalidDbSnapshotStateException, DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBSnapshot operation returned by the service.
- See Also:
-
deleteDBSnapshot
default DeleteDbSnapshotResponse deleteDBSnapshot(Consumer<DeleteDbSnapshotRequest.Builder> deleteDbSnapshotRequest) throws InvalidDbSnapshotStateException, DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteDBSnapshot operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest
-- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbSubnetGroupRequest.builder()
- Parameters:
deleteDbSubnetGroupRequest
- AConsumer
that will call methods onDeleteDbSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, RdsException Deletes an RDS event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) throws IntegrationNotFoundException, IntegrationConflictOperationException, InvalidIntegrationStateException, AwsServiceException, SdkClientException, RdsException Deletes a zero-ETL integration with Amazon Redshift.
- Parameters:
deleteIntegrationRequest
-- Returns:
- Result of the DeleteIntegration operation returned by the service.
- See Also:
-
deleteIntegration
default DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) throws IntegrationNotFoundException, IntegrationConflictOperationException, InvalidIntegrationStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteIntegration operation returned by the service.
- See Also:
-
deleteOptionGroup
default DeleteOptionGroupResponse deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) throws OptionGroupNotFoundException, InvalidOptionGroupStateException, AwsServiceException, SdkClientException, RdsException Deletes an existing option group.
- Parameters:
deleteOptionGroupRequest
-- Returns:
- Result of the DeleteOptionGroup operation returned by the service.
- See Also:
-
deleteOptionGroup
default DeleteOptionGroupResponse deleteOptionGroup(Consumer<DeleteOptionGroupRequest.Builder> deleteOptionGroupRequest) throws OptionGroupNotFoundException, InvalidOptionGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteOptionGroup operation returned by the service.
- See Also:
-
deleteTenantDatabase
default DeleteTenantDatabaseResponse deleteTenantDatabase(DeleteTenantDatabaseRequest deleteTenantDatabaseRequest) throws DbInstanceNotFoundException, TenantDatabaseNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteTenantDatabase operation returned by the service.
- See Also:
-
deleteTenantDatabase
default DeleteTenantDatabaseResponse deleteTenantDatabase(Consumer<DeleteTenantDatabaseRequest.Builder> deleteTenantDatabaseRequest) throws DbInstanceNotFoundException, TenantDatabaseNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeleteTenantDatabase operation returned by the service.
- See Also:
-
deregisterDBProxyTargets
default DeregisterDbProxyTargetsResponse deregisterDBProxyTargets(DeregisterDbProxyTargetsRequest deregisterDbProxyTargetsRequest) throws DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Remove the association between one or more
DBProxyTarget
data structures and aDBProxyTargetGroup
.- Parameters:
deregisterDbProxyTargetsRequest
-- Returns:
- Result of the DeregisterDBProxyTargets operation returned by the service.
- See Also:
-
deregisterDBProxyTargets
default DeregisterDbProxyTargetsResponse deregisterDBProxyTargets(Consumer<DeregisterDbProxyTargetsRequest.Builder> deregisterDbProxyTargetsRequest) throws DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DeregisterDBProxyTargets operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException, RdsExceptionLists 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:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeBlueGreenDeployments
default DescribeBlueGreenDeploymentsResponse describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) throws BlueGreenDeploymentNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeBlueGreenDeployments operation returned by the service.
- See Also:
-
describeBlueGreenDeployments
default DescribeBlueGreenDeploymentsResponse describeBlueGreenDeployments(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) throws BlueGreenDeploymentNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeBlueGreenDeployments operation returned by the service.
- See Also:
-
describeBlueGreenDeploymentsPaginator
default DescribeBlueGreenDeploymentsIterable describeBlueGreenDeploymentsPaginator(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest) throws BlueGreenDeploymentNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client .describeBlueGreenDeploymentsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation.- Parameters:
describeBlueGreenDeploymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBlueGreenDeploymentsPaginator
default DescribeBlueGreenDeploymentsIterable describeBlueGreenDeploymentsPaginator(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest) throws BlueGreenDeploymentNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeBlueGreenDeployments(software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client .describeBlueGreenDeploymentsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeBlueGreenDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCertificates
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeCertificates operation returned by the service.
- See Also:
-
describeCertificates
default DescribeCertificatesResponse describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeCertificates operation returned by the service.
- See Also:
-
describeCertificates
default DescribeCertificatesResponse describeCertificates() throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsExceptionLists 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:
- Result of the DescribeCertificates operation returned by the service.
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesIterable describeCertificatesPaginator() throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client .describeCertificatesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesIterable describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client .describeCertificatesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation.- Parameters:
describeCertificatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesIterable describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeCertificates(software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client .describeCertificatesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterAutomatedBackups
default DescribeDbClusterAutomatedBackupsResponse describeDBClusterAutomatedBackups(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) throws DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterAutomatedBackups operation returned by the service.
- See Also:
-
describeDBClusterAutomatedBackups
default DescribeDbClusterAutomatedBackupsResponse describeDBClusterAutomatedBackups(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) throws DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterAutomatedBackups operation returned by the service.
- See Also:
-
describeDBClusterAutomatedBackupsPaginator
default DescribeDBClusterAutomatedBackupsIterable describeDBClusterAutomatedBackupsPaginator(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest) throws DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client.describeDBClusterAutomatedBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client .describeDBClusterAutomatedBackupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client.describeDBClusterAutomatedBackupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation.- Parameters:
describeDbClusterAutomatedBackupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterAutomatedBackupsPaginator
default DescribeDBClusterAutomatedBackupsIterable describeDBClusterAutomatedBackupsPaginator(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest) throws DbClusterAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client.describeDBClusterAutomatedBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client .describeDBClusterAutomatedBackupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterAutomatedBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterAutomatedBackupsIterable responses = client.describeDBClusterAutomatedBackupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterBacktracks
default DescribeDbClusterBacktracksResponse describeDBClusterBacktracks(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) throws DbClusterNotFoundException, DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterBacktracks operation returned by the service.
- See Also:
-
describeDBClusterBacktracks
default DescribeDbClusterBacktracksResponse describeDBClusterBacktracks(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) throws DbClusterNotFoundException, DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterBacktracks operation returned by the service.
- See Also:
-
describeDBClusterBacktracksPaginator
default DescribeDBClusterBacktracksIterable describeDBClusterBacktracksPaginator(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) throws DbClusterNotFoundException, DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client .describeDBClusterBacktracksPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation.- Parameters:
describeDbClusterBacktracksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterBacktracksPaginator
default DescribeDBClusterBacktracksIterable describeDBClusterBacktracksPaginator(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest) throws DbClusterNotFoundException, DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterBacktracks(software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client .describeDBClusterBacktracksPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- See Also:
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- See Also:
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
- Returns:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation.- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation.- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation.- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation.- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionDescribes 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:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation.- Parameters:
describeDbClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException Describes the properties of specific versions of DB engines.
- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, RdsExceptionDescribes the properties of specific versions of DB engines.
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation.- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstanceAutomatedBackups
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
- See Also:
-
describeDBInstanceAutomatedBackups
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
- See Also:
-
describeDBInstanceAutomatedBackups
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups() throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionDisplays 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:
- Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator() throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client .describeDBInstanceAutomatedBackupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest) throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client .describeDBInstanceAutomatedBackupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation.- Parameters:
describeDbInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstanceAutomatedBackupsPaginator
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest) throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client .describeDBInstanceAutomatedBackupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionDescribes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation.- Parameters:
describeDbInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBLogFiles
default DescribeDbLogFilesResponse describeDBLogFiles(DescribeDbLogFilesRequest describeDbLogFilesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
- Parameters:
describeDbLogFilesRequest
-- Returns:
- Result of the DescribeDBLogFiles operation returned by the service.
- See Also:
-
describeDBLogFiles
default DescribeDbLogFilesResponse describeDBLogFiles(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBLogFiles operation returned by the service.
- See Also:
-
describeDBLogFilesPaginator
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(DescribeDbLogFilesRequest describeDbLogFilesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client .describeDBLogFilesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation.- Parameters:
describeDbLogFilesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBLogFilesPaginator
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(Consumer<DescribeDbLogFilesRequest.Builder> describeDbLogFilesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client .describeDBLogFilesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDbParametersRequest
-- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- See Also:
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns the detailed parameter list for a particular DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation.- Parameters:
describeDbParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxies
default DescribeDbProxiesResponse describeDBProxies(DescribeDbProxiesRequest describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about DB proxies.
- Parameters:
describeDbProxiesRequest
-- Returns:
- Result of the DescribeDBProxies operation returned by the service.
- See Also:
-
describeDBProxies
default DescribeDbProxiesResponse describeDBProxies(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBProxies operation returned by the service.
- See Also:
-
describeDBProxiesPaginator
default DescribeDBProxiesIterable describeDBProxiesPaginator(DescribeDbProxiesRequest describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client .describeDBProxiesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation.- Parameters:
describeDbProxiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxiesPaginator
default DescribeDBProxiesIterable describeDBProxiesPaginator(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxies(software.amazon.awssdk.services.rds.model.DescribeDbProxiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client .describeDBProxiesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyEndpoints
default DescribeDbProxyEndpointsResponse describeDBProxyEndpoints(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about DB proxy endpoints.
- Parameters:
describeDbProxyEndpointsRequest
-- Returns:
- Result of the DescribeDBProxyEndpoints operation returned by the service.
- See Also:
-
describeDBProxyEndpoints
default DescribeDbProxyEndpointsResponse describeDBProxyEndpoints(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBProxyEndpoints operation returned by the service.
- See Also:
-
describeDBProxyEndpointsPaginator
default DescribeDBProxyEndpointsIterable describeDBProxyEndpointsPaginator(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client .describeDBProxyEndpointsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation.- Parameters:
describeDbProxyEndpointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyEndpointsPaginator
default DescribeDBProxyEndpointsIterable describeDBProxyEndpointsPaginator(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyEndpoints(software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client .describeDBProxyEndpointsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyTargetGroups
default DescribeDbProxyTargetGroupsResponse describeDBProxyTargetGroups(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Returns information about DB proxy target groups, represented by
DBProxyTargetGroup
data structures.- Parameters:
describeDbProxyTargetGroupsRequest
-- Returns:
- Result of the DescribeDBProxyTargetGroups operation returned by the service.
- See Also:
-
describeDBProxyTargetGroups
default DescribeDbProxyTargetGroupsResponse describeDBProxyTargetGroups(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBProxyTargetGroups operation returned by the service.
- See Also:
-
describeDBProxyTargetGroupsPaginator
default DescribeDBProxyTargetGroupsIterable describeDBProxyTargetGroupsPaginator(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client .describeDBProxyTargetGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation.- Parameters:
describeDbProxyTargetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyTargetGroupsPaginator
default DescribeDBProxyTargetGroupsIterable describeDBProxyTargetGroupsPaginator(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyTargetGroups(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client .describeDBProxyTargetGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyTargets
default DescribeDbProxyTargetsResponse describeDBProxyTargets(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Returns information about
DBProxyTarget
objects. This API supports pagination.- Parameters:
describeDbProxyTargetsRequest
-- Returns:
- Result of the DescribeDBProxyTargets operation returned by the service.
- See Also:
-
describeDBProxyTargets
default DescribeDbProxyTargetsResponse describeDBProxyTargets(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBProxyTargets operation returned by the service.
- See Also:
-
describeDBProxyTargetsPaginator
default DescribeDBProxyTargetsIterable describeDBProxyTargetsPaginator(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client .describeDBProxyTargetsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation.- Parameters:
describeDbProxyTargetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBProxyTargetsPaginator
default DescribeDBProxyTargetsIterable describeDBProxyTargetsPaginator(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBProxyTargets(software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client .describeDBProxyTargetsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBRecommendations
default DescribeDbRecommendationsResponse describeDBRecommendations(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) throws AwsServiceException, SdkClientException, RdsException Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
- Parameters:
describeDbRecommendationsRequest
-- Returns:
- Result of the DescribeDBRecommendations operation returned by the service.
- See Also:
-
describeDBRecommendations
default DescribeDbRecommendationsResponse describeDBRecommendations(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBRecommendations operation returned by the service.
- See Also:
-
describeDBRecommendationsPaginator
default DescribeDBRecommendationsIterable describeDBRecommendationsPaginator(DescribeDbRecommendationsRequest describeDbRecommendationsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client.describeDBRecommendationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client .describeDBRecommendationsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client.describeDBRecommendationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation.- Parameters:
describeDbRecommendationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBRecommendationsPaginator
default DescribeDBRecommendationsIterable describeDBRecommendationsPaginator(Consumer<DescribeDbRecommendationsRequest.Builder> describeDbRecommendationsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBRecommendations(software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client.describeDBRecommendationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client .describeDBRecommendationsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBRecommendationsIterable responses = client.describeDBRecommendationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSecurityGroups
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSecurityGroups operation returned by the service.
- See Also:
-
describeDBSecurityGroups
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSecurityGroups operation returned by the service.
- See Also:
-
describeDBSecurityGroups
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups() throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeDBSecurityGroups operation returned by the service.
- See Also:
-
describeDBSecurityGroupsPaginator
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator() throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client .describeDBSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSecurityGroupsPaginator
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client .describeDBSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation.- Parameters:
describeDbSecurityGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSecurityGroupsPaginator
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client .describeDBSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBShardGroups
default DescribeDbShardGroupsResponse describeDBShardGroups(DescribeDbShardGroupsRequest describeDbShardGroupsRequest) throws DbShardGroupNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException Describes existing Aurora Limitless Database DB shard groups.
- Parameters:
describeDbShardGroupsRequest
-- Returns:
- Result of the DescribeDBShardGroups operation returned by the service.
- See Also:
-
describeDBShardGroups
default DescribeDbShardGroupsResponse describeDBShardGroups(Consumer<DescribeDbShardGroupsRequest.Builder> describeDbShardGroupsRequest) throws DbShardGroupNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBShardGroups operation returned by the service.
- See Also:
-
describeDBSnapshotAttributes
default DescribeDbSnapshotAttributesResponse describeDBSnapshotAttributes(DescribeDbSnapshotAttributesRequest describeDbSnapshotAttributesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBSnapshotAttributes
default DescribeDbSnapshotAttributesResponse describeDBSnapshotAttributes(Consumer<DescribeDbSnapshotAttributesRequest.Builder> describeDbSnapshotAttributesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBSnapshotTenantDatabases
default DescribeDbSnapshotTenantDatabasesResponse describeDBSnapshotTenantDatabases(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSnapshotTenantDatabases operation returned by the service.
- See Also:
-
describeDBSnapshotTenantDatabases
default DescribeDbSnapshotTenantDatabasesResponse describeDBSnapshotTenantDatabases(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSnapshotTenantDatabases operation returned by the service.
- See Also:
-
describeDBSnapshotTenantDatabasesPaginator
default DescribeDBSnapshotTenantDatabasesIterable describeDBSnapshotTenantDatabasesPaginator(DescribeDbSnapshotTenantDatabasesRequest describeDbSnapshotTenantDatabasesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client.describeDBSnapshotTenantDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client .describeDBSnapshotTenantDatabasesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client.describeDBSnapshotTenantDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation.- Parameters:
describeDbSnapshotTenantDatabasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSnapshotTenantDatabasesPaginator
default DescribeDBSnapshotTenantDatabasesIterable describeDBSnapshotTenantDatabasesPaginator(Consumer<DescribeDbSnapshotTenantDatabasesRequest.Builder> describeDbSnapshotTenantDatabasesRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSnapshotTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client.describeDBSnapshotTenantDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client .describeDBSnapshotTenantDatabasesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotTenantDatabasesIterable responses = client.describeDBSnapshotTenantDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSnapshots
default DescribeDbSnapshotsResponse describeDBSnapshots(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about DB snapshots. This API action supports pagination.
- Parameters:
describeDbSnapshotsRequest
-- Returns:
- Result of the DescribeDBSnapshots operation returned by the service.
- See Also:
-
describeDBSnapshots
default DescribeDbSnapshotsResponse describeDBSnapshots(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeDBSnapshots operation returned by the service.
- See Also:
-
describeDBSnapshots
default DescribeDbSnapshotsResponse describeDBSnapshots() throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns information about DB snapshots. This API action supports pagination.
- Returns:
- Result of the DescribeDBSnapshots operation returned by the service.
- See Also:
-
describeDBSnapshotsPaginator
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator() throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client .describeDBSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSnapshotsPaginator
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client .describeDBSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation.- Parameters:
describeDbSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSnapshotsPaginator
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client .describeDBSnapshotsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation.- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- See Also:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException Returns the default engine and system parameter information for the specified database engine.
- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException Returns the default engine and system parameter information for the specified database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation.- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, RdsExceptionDisplays 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:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsExceptionLists 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:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeExportTasks
default DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws ExportTaskNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
- Parameters:
describeExportTasksRequest
-- Returns:
- Result of the DescribeExportTasks operation returned by the service.
- See Also:
-
describeExportTasks
default DescribeExportTasksResponse describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) throws ExportTaskNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeExportTasks operation returned by the service.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksIterable describeExportTasksPaginator(DescribeExportTasksRequest describeExportTasksRequest) throws ExportTaskNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client .describeExportTasksPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation.- Parameters:
describeExportTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeExportTasksPaginator
default DescribeExportTasksIterable describeExportTasksPaginator(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest) throws ExportTaskNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeExportTasks(software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client .describeExportTasksPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeExportTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters() throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator() throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.- Parameters:
describeGlobalClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeIntegrations
default DescribeIntegrationsResponse describeIntegrations(DescribeIntegrationsRequest describeIntegrationsRequest) throws IntegrationNotFoundException, AwsServiceException, SdkClientException, RdsException Describe one or more zero-ETL integrations with Amazon Redshift.
- Parameters:
describeIntegrationsRequest
-- Returns:
- Result of the DescribeIntegrations operation returned by the service.
- See Also:
-
describeIntegrations
default DescribeIntegrationsResponse describeIntegrations(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) throws IntegrationNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeIntegrations operation returned by the service.
- See Also:
-
describeIntegrationsPaginator
default DescribeIntegrationsIterable describeIntegrationsPaginator(DescribeIntegrationsRequest describeIntegrationsRequest) throws IntegrationNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client.describeIntegrationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client .describeIntegrationsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client.describeIntegrationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation.- Parameters:
describeIntegrationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeIntegrationsPaginator
default DescribeIntegrationsIterable describeIntegrationsPaginator(Consumer<DescribeIntegrationsRequest.Builder> describeIntegrationsRequest) throws IntegrationNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeIntegrations(software.amazon.awssdk.services.rds.model.DescribeIntegrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client.describeIntegrationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client .describeIntegrationsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeIntegrationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeIntegrationsIterable responses = client.describeIntegrationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptionGroupOptions
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException Describes all available options for the specified engine.
- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- Result of the DescribeOptionGroupOptions operation returned by the service.
- See Also:
-
describeOptionGroupOptions
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeOptionGroupOptions operation returned by the service.
- See Also:
-
describeOptionGroupOptionsPaginator
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client .describeOptionGroupOptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation.- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptionGroupOptionsPaginator
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client .describeOptionGroupOptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptionGroups
default DescribeOptionGroupsResponse describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Describes the available option groups.
- Parameters:
describeOptionGroupsRequest
-- Returns:
- Result of the DescribeOptionGroups operation returned by the service.
- See Also:
-
describeOptionGroups
default DescribeOptionGroupsResponse describeOptionGroups(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeOptionGroups operation returned by the service.
- See Also:
-
describeOptionGroups
default DescribeOptionGroupsResponse describeOptionGroups() throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionDescribes the available option groups.
- Returns:
- Result of the DescribeOptionGroups operation returned by the service.
- See Also:
-
describeOptionGroupsPaginator
default DescribeOptionGroupsIterable describeOptionGroupsPaginator() throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client .describeOptionGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptionGroupsPaginator
default DescribeOptionGroupsIterable describeOptionGroupsPaginator(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client .describeOptionGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation.- Parameters:
describeOptionGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptionGroupsPaginator
default DescribeOptionGroupsIterable describeOptionGroupsPaginator(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client .describeOptionGroupsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException Describes the orderable DB instance options for a specified DB engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation.- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation.- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstances
default DescribeReservedDbInstancesResponse describeReservedDBInstances(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Parameters:
describeReservedDbInstancesRequest
-- Returns:
- Result of the DescribeReservedDBInstances operation returned by the service.
- See Also:
-
describeReservedDBInstances
default DescribeReservedDbInstancesResponse describeReservedDBInstances(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeReservedDBInstances operation returned by the service.
- See Also:
-
describeReservedDBInstances
default DescribeReservedDbInstancesResponse describeReservedDBInstances() throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionReturns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Returns:
- Result of the DescribeReservedDBInstances operation returned by the service.
- See Also:
-
describeReservedDBInstancesPaginator
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator() throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client .describeReservedDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstancesPaginator
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client .describeReservedDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation.- Parameters:
describeReservedDbInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstancesPaginator
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client .describeReservedDBInstancesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstancesOfferings
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException Lists available reserved DB instance offerings.
- Parameters:
describeReservedDbInstancesOfferingsRequest
-- Returns:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
- See Also:
-
describeReservedDBInstancesOfferings
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
- See Also:
-
describeReservedDBInstancesOfferings
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings() throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsExceptionLists available reserved DB instance offerings.
- Returns:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator() throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client .describeReservedDBInstancesOfferingsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client .describeReservedDBInstancesOfferingsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation.- Parameters:
describeReservedDbInstancesOfferingsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedDBInstancesOfferingsPaginator
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client .describeReservedDBInstancesOfferingsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSourceRegions
default DescribeSourceRegionsResponse describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeSourceRegions operation returned by the service.
- See Also:
-
describeSourceRegions
default DescribeSourceRegionsResponse describeSourceRegions(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeSourceRegions operation returned by the service.
- See Also:
-
describeSourceRegions
default DescribeSourceRegionsResponse describeSourceRegions() throws AwsServiceException, SdkClientException, RdsExceptionReturns 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:
- Result of the DescribeSourceRegions operation returned by the service.
- See Also:
-
describeSourceRegionsPaginator
default DescribeSourceRegionsIterable describeSourceRegionsPaginator() throws AwsServiceException, SdkClientException, RdsExceptionThis is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client .describeSourceRegionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSourceRegionsPaginator
default DescribeSourceRegionsIterable describeSourceRegionsPaginator(DescribeSourceRegionsRequest describeSourceRegionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client .describeSourceRegionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation.- Parameters:
describeSourceRegionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSourceRegionsPaginator
default DescribeSourceRegionsIterable describeSourceRegionsPaginator(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest) throws AwsServiceException, SdkClientException, RdsException This is a variant of
describeSourceRegions(software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client .describeSourceRegionsPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTenantDatabases
default DescribeTenantDatabasesResponse describeTenantDatabases(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeTenantDatabases operation returned by the service.
- See Also:
-
describeTenantDatabases
default DescribeTenantDatabasesResponse describeTenantDatabases(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeTenantDatabases operation returned by the service.
- See Also:
-
describeTenantDatabasesPaginator
default DescribeTenantDatabasesIterable describeTenantDatabasesPaginator(DescribeTenantDatabasesRequest describeTenantDatabasesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client.describeTenantDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client .describeTenantDatabasesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client.describeTenantDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation.- Parameters:
describeTenantDatabasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTenantDatabasesPaginator
default DescribeTenantDatabasesIterable describeTenantDatabasesPaginator(Consumer<DescribeTenantDatabasesRequest.Builder> describeTenantDatabasesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
describeTenantDatabases(software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client.describeTenantDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client .describeTenantDatabasesPaginator(request); for (software.amazon.awssdk.services.rds.model.DescribeTenantDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DescribeTenantDatabasesIterable responses = client.describeTenantDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- See Also:
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- See Also:
-
disableHttpEndpoint
default DisableHttpEndpointResponse disableHttpEndpoint(DisableHttpEndpointRequest disableHttpEndpointRequest) throws ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DisableHttpEndpoint operation returned by the service.
- See Also:
-
disableHttpEndpoint
default DisableHttpEndpointResponse disableHttpEndpoint(Consumer<DisableHttpEndpointRequest.Builder> disableHttpEndpointRequest) throws ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DisableHttpEndpoint operation returned by the service.
- See Also:
-
downloadDBLogFilePortion
default DownloadDbLogFilePortionResponse downloadDBLogFilePortion(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DownloadDBLogFilePortion operation returned by the service.
- See Also:
-
downloadDBLogFilePortion
default DownloadDbLogFilePortionResponse downloadDBLogFilePortion(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the DownloadDBLogFilePortion operation returned by the service.
- See Also:
-
downloadDBLogFilePortionPaginator
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client .downloadDBLogFilePortionPaginator(request); for (software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
downloadDBLogFilePortionPaginator
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(Consumer<DownloadDbLogFilePortionRequest.Builder> downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException This is a variant of
downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client .downloadDBLogFilePortionPaginator(request); for (software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
enableHttpEndpoint
default EnableHttpEndpointResponse enableHttpEndpoint(EnableHttpEndpointRequest enableHttpEndpointRequest) throws ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the EnableHttpEndpoint operation returned by the service.
- See Also:
-
enableHttpEndpoint
default EnableHttpEndpointResponse enableHttpEndpoint(Consumer<EnableHttpEndpointRequest.Builder> enableHttpEndpointRequest) throws ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the EnableHttpEndpoint operation returned by the service.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the FailoverDBCluster operation returned by the service.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the FailoverDBCluster operation returned by the service.
- See Also:
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the FailoverGlobalCluster operation returned by the service.
- See Also:
-
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the FailoverGlobalCluster operation returned by the service.
- See Also:
-
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
modifyActivityStream
default ModifyActivityStreamResponse modifyActivityStream(ModifyActivityStreamRequest modifyActivityStreamRequest) throws InvalidDbInstanceStateException, ResourceNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyActivityStream operation returned by the service.
- See Also:
-
modifyActivityStream
default ModifyActivityStreamResponse modifyActivityStream(Consumer<ModifyActivityStreamRequest.Builder> modifyActivityStreamRequest) throws InvalidDbInstanceStateException, ResourceNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyActivityStream operation returned by the service.
- See Also:
-
modifyCertificates
default ModifyCertificatesResponse modifyCertificates(ModifyCertificatesRequest modifyCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCertificates operation returned by the service.
- See Also:
-
-
modifyCertificates
default ModifyCertificatesResponse modifyCertificates(Consumer<ModifyCertificatesRequest.Builder> modifyCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCertificates operation returned by the service.
- See Also:
-
-
modifyCurrentDBClusterCapacity
default ModifyCurrentDbClusterCapacityResponse modifyCurrentDBClusterCapacity(ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbClusterCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
- See Also:
-
modifyCurrentDBClusterCapacity
default ModifyCurrentDbClusterCapacityResponse modifyCurrentDBClusterCapacity(Consumer<ModifyCurrentDbClusterCapacityRequest.Builder> modifyCurrentDbClusterCapacityRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbClusterCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
- See Also:
-
modifyCustomDBEngineVersion
default ModifyCustomDbEngineVersionResponse modifyCustomDBEngineVersion(ModifyCustomDbEngineVersionRequest modifyCustomDbEngineVersionRequest) throws CustomDbEngineVersionNotFoundException, InvalidCustomDbEngineVersionStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCustomDBEngineVersion operation returned by the service.
- See Also:
-
modifyCustomDBEngineVersion
default ModifyCustomDbEngineVersionResponse modifyCustomDBEngineVersion(Consumer<ModifyCustomDbEngineVersionRequest.Builder> modifyCustomDbEngineVersionRequest) throws CustomDbEngineVersionNotFoundException, InvalidCustomDbEngineVersionStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyCustomDBEngineVersion operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, DbInstanceAlreadyExistsException, DomainNotFoundException, StorageTypeNotAvailableException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, DbInstanceAlreadyExistsException, DomainNotFoundException, StorageTypeNotAvailableException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
- Parameters:
modifyDbClusterEndpointRequest
-- Returns:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- See Also:
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, KmsKeyNotAccessibleException, InvalidDbClusterStateException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, KmsKeyNotAccessibleException, InvalidDbClusterStateException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBParameterGroup operation returned by the service.
- See Also:
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBParameterGroup operation returned by the service.
- See Also:
-
modifyDBProxy
default ModifyDbProxyResponse modifyDBProxy(ModifyDbProxyRequest modifyDbProxyRequest) throws DbProxyNotFoundException, DbProxyAlreadyExistsException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Changes the settings for an existing DB proxy.
- Parameters:
modifyDbProxyRequest
-- Returns:
- Result of the ModifyDBProxy operation returned by the service.
- See Also:
-
modifyDBProxy
default ModifyDbProxyResponse modifyDBProxy(Consumer<ModifyDbProxyRequest.Builder> modifyDbProxyRequest) throws DbProxyNotFoundException, DbProxyAlreadyExistsException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBProxy operation returned by the service.
- See Also:
-
modifyDBProxyEndpoint
default ModifyDbProxyEndpointResponse modifyDBProxyEndpoint(ModifyDbProxyEndpointRequest modifyDbProxyEndpointRequest) throws DbProxyEndpointNotFoundException, DbProxyEndpointAlreadyExistsException, InvalidDbProxyEndpointStateException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Changes the settings for an existing DB proxy endpoint.
- Parameters:
modifyDbProxyEndpointRequest
-- Returns:
- Result of the ModifyDBProxyEndpoint operation returned by the service.
- See Also:
-
modifyDBProxyEndpoint
default ModifyDbProxyEndpointResponse modifyDBProxyEndpoint(Consumer<ModifyDbProxyEndpointRequest.Builder> modifyDbProxyEndpointRequest) throws DbProxyEndpointNotFoundException, DbProxyEndpointAlreadyExistsException, InvalidDbProxyEndpointStateException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBProxyEndpoint operation returned by the service.
- See Also:
-
modifyDBProxyTargetGroup
default ModifyDbProxyTargetGroupResponse modifyDBProxyTargetGroup(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException Modifies the properties of a
DBProxyTargetGroup
.- Parameters:
modifyDbProxyTargetGroupRequest
-- Returns:
- Result of the ModifyDBProxyTargetGroup operation returned by the service.
- See Also:
-
modifyDBProxyTargetGroup
default ModifyDbProxyTargetGroupResponse modifyDBProxyTargetGroup(Consumer<ModifyDbProxyTargetGroupRequest.Builder> modifyDbProxyTargetGroupRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBProxyTargetGroup operation returned by the service.
- See Also:
-
modifyDBRecommendation
default ModifyDbRecommendationResponse modifyDBRecommendation(ModifyDbRecommendationRequest modifyDbRecommendationRequest) throws AwsServiceException, SdkClientException, RdsException Updates the recommendation status and recommended action status for the specified recommendation.
- Parameters:
modifyDbRecommendationRequest
-- Returns:
- Result of the ModifyDBRecommendation operation returned by the service.
- See Also:
-
modifyDBRecommendation
default ModifyDbRecommendationResponse modifyDBRecommendation(Consumer<ModifyDbRecommendationRequest.Builder> modifyDbRecommendationRequest) throws AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBRecommendation operation returned by the service.
- See Also:
-
modifyDBShardGroup
default ModifyDbShardGroupResponse modifyDBShardGroup(ModifyDbShardGroupRequest modifyDbShardGroupRequest) throws InvalidDbClusterStateException, DbShardGroupAlreadyExistsException, DbShardGroupNotFoundException, InvalidMaxAcuException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBShardGroup operation returned by the service.
- See Also:
-
modifyDBShardGroup
default ModifyDbShardGroupResponse modifyDBShardGroup(Consumer<ModifyDbShardGroupRequest.Builder> modifyDbShardGroupRequest) throws InvalidDbClusterStateException, DbShardGroupAlreadyExistsException, DbShardGroupNotFoundException, InvalidMaxAcuException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBShardGroup operation returned by the service.
- See Also:
-
modifyDBSnapshot
default ModifyDbSnapshotResponse modifyDBSnapshot(ModifyDbSnapshotRequest modifyDbSnapshotRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSnapshot operation returned by the service.
- See Also:
-
modifyDBSnapshot
default ModifyDbSnapshotResponse modifyDBSnapshot(Consumer<ModifyDbSnapshotRequest.Builder> modifyDbSnapshotRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSnapshot operation returned by the service.
- See Also:
-
modifyDBSnapshotAttribute
default ModifyDbSnapshotAttributeResponse modifyDBSnapshotAttribute(ModifyDbSnapshotAttributeRequest modifyDbSnapshotAttributeRequest) throws DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBSnapshotAttribute
default ModifyDbSnapshotAttributeResponse modifyDBSnapshotAttribute(Consumer<ModifyDbSnapshotAttributeRequest.Builder> modifyDbSnapshotAttributeRequest) throws DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyGlobalCluster operation returned by the service.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyGlobalCluster operation returned by the service.
- See Also:
-
modifyIntegration
default ModifyIntegrationResponse modifyIntegration(ModifyIntegrationRequest modifyIntegrationRequest) throws IntegrationNotFoundException, InvalidIntegrationStateException, IntegrationConflictOperationException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyIntegration operation returned by the service.
- See Also:
-
modifyIntegration
default ModifyIntegrationResponse modifyIntegration(Consumer<ModifyIntegrationRequest.Builder> modifyIntegrationRequest) throws IntegrationNotFoundException, InvalidIntegrationStateException, IntegrationConflictOperationException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyIntegration operation returned by the service.
- See Also:
-
modifyOptionGroup
default ModifyOptionGroupResponse modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) throws InvalidOptionGroupStateException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Modifies an existing option group.
- Parameters:
modifyOptionGroupRequest
-- Returns:
- Result of the ModifyOptionGroup operation returned by the service.
- See Also:
-
modifyOptionGroup
default ModifyOptionGroupResponse modifyOptionGroup(Consumer<ModifyOptionGroupRequest.Builder> modifyOptionGroupRequest) throws InvalidOptionGroupStateException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyOptionGroup operation returned by the service.
- See Also:
-
modifyTenantDatabase
default ModifyTenantDatabaseResponse modifyTenantDatabase(ModifyTenantDatabaseRequest modifyTenantDatabaseRequest) throws DbInstanceNotFoundException, TenantDatabaseNotFoundException, TenantDatabaseAlreadyExistsException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyTenantDatabase operation returned by the service.
- See Also:
-
modifyTenantDatabase
default ModifyTenantDatabaseResponse modifyTenantDatabase(Consumer<ModifyTenantDatabaseRequest.Builder> modifyTenantDatabaseRequest) throws DbInstanceNotFoundException, TenantDatabaseNotFoundException, TenantDatabaseAlreadyExistsException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ModifyTenantDatabase operation returned by the service.
- See Also:
-
promoteReadReplica
default PromoteReadReplicaResponse promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the PromoteReadReplica operation returned by the service.
- See Also:
-
-
promoteReadReplica
default PromoteReadReplicaResponse promoteReadReplica(Consumer<PromoteReadReplicaRequest.Builder> promoteReadReplicaRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the PromoteReadReplica operation returned by the service.
- See Also:
-
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException Promotes a read replica DB cluster to a standalone DB cluster.
- Parameters:
promoteReadReplicaDbClusterRequest
-- Returns:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- See Also:
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- See Also:
-
purchaseReservedDBInstancesOffering
default PurchaseReservedDbInstancesOfferingResponse purchaseReservedDBInstancesOffering(PurchaseReservedDbInstancesOfferingRequest purchaseReservedDbInstancesOfferingRequest) throws ReservedDbInstancesOfferingNotFoundException, ReservedDbInstanceAlreadyExistsException, ReservedDbInstanceQuotaExceededException, AwsServiceException, SdkClientException, RdsException Purchases a reserved DB instance offering.
- Parameters:
purchaseReservedDbInstancesOfferingRequest
-- Returns:
- Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
- See Also:
-
purchaseReservedDBInstancesOffering
default PurchaseReservedDbInstancesOfferingResponse purchaseReservedDBInstancesOffering(Consumer<PurchaseReservedDbInstancesOfferingRequest.Builder> purchaseReservedDbInstancesOfferingRequest) throws ReservedDbInstancesOfferingNotFoundException, ReservedDbInstanceAlreadyExistsException, ReservedDbInstanceQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
- See Also:
-
rebootDBCluster
default RebootDbClusterResponse rebootDBCluster(RebootDbClusterRequest rebootDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBCluster operation returned by the service.
- See Also:
-
rebootDBCluster
default RebootDbClusterResponse rebootDBCluster(Consumer<RebootDbClusterRequest.Builder> rebootDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBCluster operation returned by the service.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBInstance operation returned by the service.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBInstance operation returned by the service.
- See Also:
-
rebootDBShardGroup
default RebootDbShardGroupResponse rebootDBShardGroup(RebootDbShardGroupRequest rebootDbShardGroupRequest) throws DbShardGroupNotFoundException, InvalidDbShardGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBShardGroup operation returned by the service.
- See Also:
-
rebootDBShardGroup
default RebootDbShardGroupResponse rebootDBShardGroup(Consumer<RebootDbShardGroupRequest.Builder> rebootDbShardGroupRequest) throws DbShardGroupNotFoundException, InvalidDbShardGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RebootDBShardGroup operation returned by the service.
- See Also:
-
registerDBProxyTargets
default RegisterDbProxyTargetsResponse registerDBProxyTargets(RegisterDbProxyTargetsRequest registerDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, DbProxyTargetAlreadyRegisteredException, InvalidDbInstanceStateException, InvalidDbClusterStateException, InvalidDbProxyStateException, InsufficientAvailableIPsInSubnetException, AwsServiceException, SdkClientException, RdsException Associate one or more
DBProxyTarget
data structures with aDBProxyTargetGroup
.- Parameters:
registerDbProxyTargetsRequest
-- Returns:
- Result of the RegisterDBProxyTargets operation returned by the service.
- See Also:
-
registerDBProxyTargets
default RegisterDbProxyTargetsResponse registerDBProxyTargets(Consumer<RegisterDbProxyTargetsRequest.Builder> registerDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, DbProxyTargetAlreadyRegisteredException, InvalidDbInstanceStateException, InvalidDbClusterStateException, InvalidDbProxyStateException, InsufficientAvailableIPsInSubnetException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RegisterDBProxyTargets operation returned by the service.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- See Also:
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- See Also:
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- See Also:
-
removeRoleFromDBInstance
default RemoveRoleFromDbInstanceResponse removeRoleFromDBInstance(RemoveRoleFromDbInstanceRequest removeRoleFromDbInstanceRequest) throws DbInstanceNotFoundException, DbInstanceRoleNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
- Parameters:
removeRoleFromDbInstanceRequest
-- Returns:
- Result of the RemoveRoleFromDBInstance operation returned by the service.
- See Also:
-
removeRoleFromDBInstance
default RemoveRoleFromDbInstanceResponse removeRoleFromDBInstance(Consumer<RemoveRoleFromDbInstanceRequest.Builder> removeRoleFromDbInstanceRequest) throws DbInstanceNotFoundException, DbInstanceRoleNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveRoleFromDBInstance operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException Removes a source identifier from an existing RDS event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, IntegrationNotFoundException, TenantDatabaseNotFoundException, DbSnapshotTenantDatabaseNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- See Also:
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Parameters:
resetDbParameterGroupRequest
-- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- See Also:
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.
This is a convenience which creates an instance of the
ResetDbParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbParameterGroupRequest.builder()
- Parameters:
resetDbParameterGroupRequest
- AConsumer
that will call methods onResetDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- See Also:
-
restoreDBClusterFromS3
default RestoreDbClusterFromS3Response restoreDBClusterFromS3(RestoreDbClusterFromS3Request restoreDbClusterFromS3Request) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidS3BucketException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DomainNotFoundException, InsufficientStorageClusterCapacityException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterFromS3 operation returned by the service.
- See Also:
-
restoreDBClusterFromS3
default RestoreDbClusterFromS3Response restoreDBClusterFromS3(Consumer<RestoreDbClusterFromS3Request.Builder> restoreDbClusterFromS3Request) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidS3BucketException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DomainNotFoundException, InsufficientStorageClusterCapacityException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterFromS3 operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, DbClusterAutomatedBackupNotFoundException, InsufficientDbInstanceCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, DbClusterAutomatedBackupNotFoundException, InsufficientDbInstanceCapacityException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
restoreDBInstanceFromDBSnapshot
default RestoreDbInstanceFromDbSnapshotResponse restoreDBInstanceFromDBSnapshot(RestoreDbInstanceFromDbSnapshotRequest restoreDbInstanceFromDbSnapshotRequest) throws DbInstanceAlreadyExistsException, DbSnapshotNotFoundException, InstanceQuotaExceededException, InsufficientDbInstanceCapacityException, InvalidDbSnapshotStateException, StorageQuotaExceededException, InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException, DbParameterGroupNotFoundException, NetworkTypeNotSupportedException, DbClusterSnapshotNotFoundException, CertificateNotFoundException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
- See Also:
-
restoreDBInstanceFromDBSnapshot
default RestoreDbInstanceFromDbSnapshotResponse restoreDBInstanceFromDBSnapshot(Consumer<RestoreDbInstanceFromDbSnapshotRequest.Builder> restoreDbInstanceFromDbSnapshotRequest) throws DbInstanceAlreadyExistsException, DbSnapshotNotFoundException, InstanceQuotaExceededException, InsufficientDbInstanceCapacityException, InvalidDbSnapshotStateException, StorageQuotaExceededException, InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException, DbParameterGroupNotFoundException, NetworkTypeNotSupportedException, DbClusterSnapshotNotFoundException, CertificateNotFoundException, TenantDatabaseQuotaExceededException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
- See Also:
-
restoreDBInstanceFromS3
default RestoreDbInstanceFromS3Response restoreDBInstanceFromS3(RestoreDbInstanceFromS3Request restoreDbInstanceFromS3Request) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, InvalidS3BucketException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, NetworkTypeNotSupportedException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceFromS3 operation returned by the service.
- See Also:
-
restoreDBInstanceFromS3
default RestoreDbInstanceFromS3Response restoreDBInstanceFromS3(Consumer<RestoreDbInstanceFromS3Request.Builder> restoreDbInstanceFromS3Request) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, InvalidS3BucketException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, NetworkTypeNotSupportedException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceFromS3 operation returned by the service.
- See Also:
-
restoreDBInstanceToPointInTime
default RestoreDbInstanceToPointInTimeResponse restoreDBInstanceToPointInTime(RestoreDbInstanceToPointInTimeRequest restoreDbInstanceToPointInTimeRequest) throws DbInstanceAlreadyExistsException, DbInstanceNotFoundException, InstanceQuotaExceededException, InsufficientDbInstanceCapacityException, InvalidDbInstanceStateException, PointInTimeRestoreNotEnabledException, StorageQuotaExceededException, InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException, DbParameterGroupNotFoundException, DbInstanceAutomatedBackupNotFoundException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceToPointInTime operation returned by the service.
- See Also:
-
restoreDBInstanceToPointInTime
default RestoreDbInstanceToPointInTimeResponse restoreDBInstanceToPointInTime(Consumer<RestoreDbInstanceToPointInTimeRequest.Builder> restoreDbInstanceToPointInTimeRequest) throws DbInstanceAlreadyExistsException, DbInstanceNotFoundException, InstanceQuotaExceededException, InsufficientDbInstanceCapacityException, InvalidDbInstanceStateException, PointInTimeRestoreNotEnabledException, StorageQuotaExceededException, InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException, DbParameterGroupNotFoundException, DbInstanceAutomatedBackupNotFoundException, NetworkTypeNotSupportedException, TenantDatabaseQuotaExceededException, CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RestoreDBInstanceToPointInTime operation returned by the service.
- See Also:
-
revokeDBSecurityGroupIngress
default RevokeDbSecurityGroupIngressResponse revokeDBSecurityGroupIngress(RevokeDbSecurityGroupIngressRequest revokeDbSecurityGroupIngressRequest) throws DbSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidDbSecurityGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RevokeDBSecurityGroupIngress operation returned by the service.
- See Also:
-
revokeDBSecurityGroupIngress
default RevokeDbSecurityGroupIngressResponse revokeDBSecurityGroupIngress(Consumer<RevokeDbSecurityGroupIngressRequest.Builder> revokeDbSecurityGroupIngressRequest) throws DbSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidDbSecurityGroupStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the RevokeDBSecurityGroupIngress operation returned by the service.
- See Also:
-
startActivityStream
default StartActivityStreamResponse startActivityStream(StartActivityStreamRequest startActivityStreamRequest) throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartActivityStream operation returned by the service.
- See Also:
-
startActivityStream
default StartActivityStreamResponse startActivityStream(Consumer<StartActivityStreamRequest.Builder> startActivityStreamRequest) throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartActivityStream operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
startDBInstance
default StartDbInstanceResponse startDBInstance(StartDbInstanceRequest startDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBInstance operation returned by the service.
- See Also:
-
startDBInstance
default StartDbInstanceResponse startDBInstance(Consumer<StartDbInstanceRequest.Builder> startDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBInstance operation returned by the service.
- See Also:
-
startDBInstanceAutomatedBackupsReplication
default StartDbInstanceAutomatedBackupsReplicationResponse startDBInstanceAutomatedBackupsReplication(StartDbInstanceAutomatedBackupsReplicationRequest startDbInstanceAutomatedBackupsReplicationRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, KmsKeyNotAccessibleException, DbInstanceAutomatedBackupQuotaExceededException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBInstanceAutomatedBackupsReplication operation returned by the service.
- See Also:
-
startDBInstanceAutomatedBackupsReplication
default StartDbInstanceAutomatedBackupsReplicationResponse startDBInstanceAutomatedBackupsReplication(Consumer<StartDbInstanceAutomatedBackupsReplicationRequest.Builder> startDbInstanceAutomatedBackupsReplicationRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, KmsKeyNotAccessibleException, DbInstanceAutomatedBackupQuotaExceededException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartDBInstanceAutomatedBackupsReplication operation returned by the service.
- See Also:
-
startExportTask
default StartExportTaskResponse startExportTask(StartExportTaskRequest startExportTaskRequest) throws DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, DbClusterNotFoundException, ExportTaskAlreadyExistsException, InvalidS3BucketException, IamRoleNotFoundException, IamRoleMissingPermissionsException, InvalidExportOnlyException, KmsKeyNotAccessibleException, InvalidExportSourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartExportTask operation returned by the service.
- See Also:
-
startExportTask
default StartExportTaskResponse startExportTask(Consumer<StartExportTaskRequest.Builder> startExportTaskRequest) throws DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, DbClusterNotFoundException, ExportTaskAlreadyExistsException, InvalidS3BucketException, IamRoleNotFoundException, IamRoleMissingPermissionsException, InvalidExportOnlyException, KmsKeyNotAccessibleException, InvalidExportSourceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StartExportTask operation returned by the service.
- See Also:
-
stopActivityStream
default StopActivityStreamResponse stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest) throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopActivityStream operation returned by the service.
- See Also:
-
stopActivityStream
default StopActivityStreamResponse stopActivityStream(Consumer<StopActivityStreamRequest.Builder> stopActivityStreamRequest) throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopActivityStream operation returned by the service.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBCluster operation returned by the service.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBCluster operation returned by the service.
- See Also:
-
stopDBInstance
default StopDbInstanceResponse stopDBInstance(StopDbInstanceRequest stopDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBInstance operation returned by the service.
- See Also:
-
stopDBInstance
default StopDbInstanceResponse stopDBInstance(Consumer<StopDbInstanceRequest.Builder> stopDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBInstance operation returned by the service.
- See Also:
-
stopDBInstanceAutomatedBackupsReplication
default StopDbInstanceAutomatedBackupsReplicationResponse stopDBInstanceAutomatedBackupsReplication(StopDbInstanceAutomatedBackupsReplicationRequest stopDbInstanceAutomatedBackupsReplicationRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBInstanceAutomatedBackupsReplication operation returned by the service.
- See Also:
-
stopDBInstanceAutomatedBackupsReplication
default StopDbInstanceAutomatedBackupsReplicationResponse stopDBInstanceAutomatedBackupsReplication(Consumer<StopDbInstanceAutomatedBackupsReplicationRequest.Builder> stopDbInstanceAutomatedBackupsReplicationRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the StopDBInstanceAutomatedBackupsReplication operation returned by the service.
- See Also:
-
switchoverBlueGreenDeployment
default SwitchoverBlueGreenDeploymentResponse switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest switchoverBlueGreenDeploymentRequest) throws BlueGreenDeploymentNotFoundException, InvalidBlueGreenDeploymentStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverBlueGreenDeployment operation returned by the service.
- See Also:
-
switchoverBlueGreenDeployment
default SwitchoverBlueGreenDeploymentResponse switchoverBlueGreenDeployment(Consumer<SwitchoverBlueGreenDeploymentRequest.Builder> switchoverBlueGreenDeploymentRequest) throws BlueGreenDeploymentNotFoundException, InvalidBlueGreenDeploymentStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverBlueGreenDeployment operation returned by the service.
- See Also:
-
switchoverGlobalCluster
default SwitchoverGlobalClusterResponse switchoverGlobalCluster(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverGlobalCluster operation returned by the service.
- See Also:
-
switchoverGlobalCluster
default SwitchoverGlobalClusterResponse switchoverGlobalCluster(Consumer<SwitchoverGlobalClusterRequest.Builder> switchoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverGlobalCluster operation returned by the service.
- See Also:
-
switchoverReadReplica
default SwitchoverReadReplicaResponse switchoverReadReplica(SwitchoverReadReplicaRequest switchoverReadReplicaRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverReadReplica operation returned by the service.
- See Also:
-
switchoverReadReplica
default SwitchoverReadReplicaResponse switchoverReadReplica(Consumer<SwitchoverReadReplicaRequest.Builder> switchoverReadReplicaRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException 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:
- Result of the SwitchoverReadReplica operation returned by the service.
- See Also:
-
utilities
Creates an instance ofRdsUtilities
object with the configuration set on this client. -
waiter
Create an instance ofRdsWaiter
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
RdsWaiter
-
create
Create aRdsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRdsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-