@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface RdsClient extends AwsClient
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, 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddRoleToDbClusterResponse |
addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role with a DB cluster.
|
default AddRoleToDbClusterResponse |
addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role with a DB cluster.
|
default AddRoleToDbInstanceResponse |
addRoleToDBInstance(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest)
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
|
default AddRoleToDbInstanceResponse |
addRoleToDBInstance(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest)
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification subscription.
|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification subscription.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon RDS resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds metadata tags to an Amazon RDS resource.
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
default AuthorizeDbSecurityGroupIngressResponse |
authorizeDBSecurityGroupIngress(AuthorizeDbSecurityGroupIngressRequest authorizeDbSecurityGroupIngressRequest)
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
|
default AuthorizeDbSecurityGroupIngressResponse |
authorizeDBSecurityGroupIngress(Consumer<AuthorizeDbSecurityGroupIngressRequest.Builder> authorizeDbSecurityGroupIngressRequest)
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
|
default BacktrackDbClusterResponse |
backtrackDBCluster(BacktrackDbClusterRequest backtrackDbClusterRequest)
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
|
default BacktrackDbClusterResponse |
backtrackDBCluster(Consumer<BacktrackDbClusterRequest.Builder> 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 a
RdsClient . |
default CancelExportTaskResponse |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
|
default CancelExportTaskResponse |
cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
|
default CopyDbClusterParameterGroupResponse |
copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)
Copies the specified DB cluster parameter group.
|
default CopyDbClusterParameterGroupResponse |
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 a
RdsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateBlueGreenDeploymentResponse |
createBlueGreenDeployment(Consumer<CreateBlueGreenDeploymentRequest.Builder> createBlueGreenDeploymentRequest)
Creates a blue/green deployment.
|
default CreateBlueGreenDeploymentResponse |
createBlueGreenDeployment(CreateBlueGreenDeploymentRequest createBlueGreenDeploymentRequest)
Creates a blue/green deployment.
|
default CreateCustomDbEngineVersionResponse |
createCustomDBEngineVersion(Consumer<CreateCustomDbEngineVersionRequest.Builder> createCustomDbEngineVersionRequest)
Creates a custom DB engine version (CEV).
|
default CreateCustomDbEngineVersionResponse |
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.
|
default CreateDbClusterParameterGroupResponse |
createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)
Creates a new DB cluster parameter group.
|
default CreateDbClusterParameterGroupResponse |
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.
|
default CreateDbInstanceReadReplicaResponse |
createDBInstanceReadReplica(Consumer<CreateDbInstanceReadReplicaRequest.Builder> createDbInstanceReadReplicaRequest)
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.
|
default CreateDbInstanceReadReplicaResponse |
createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest)
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.
|
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 a
DBProxyEndpoint . |
default CreateDbProxyEndpointResponse |
createDBProxyEndpoint(CreateDbProxyEndpointRequest createDbProxyEndpointRequest)
Creates a
DBProxyEndpoint . |
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 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 CreateOptionGroupResponse |
createOptionGroup(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest)
Creates a new option group.
|
default CreateOptionGroupResponse |
createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
Creates a new option group.
|
default DeleteBlueGreenDeploymentResponse |
deleteBlueGreenDeployment(Consumer<DeleteBlueGreenDeploymentRequest.Builder> deleteBlueGreenDeploymentRequest)
Deletes a blue/green deployment.
|
default DeleteBlueGreenDeploymentResponse |
deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest deleteBlueGreenDeploymentRequest)
Deletes a blue/green deployment.
|
default DeleteCustomDbEngineVersionResponse |
deleteCustomDBEngineVersion(Consumer<DeleteCustomDbEngineVersionRequest.Builder> deleteCustomDbEngineVersionRequest)
Deletes a custom engine version.
|
default DeleteCustomDbEngineVersionResponse |
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.
|
default DeleteDbClusterAutomatedBackupResponse |
deleteDBClusterAutomatedBackup(Consumer<DeleteDbClusterAutomatedBackupRequest.Builder> deleteDbClusterAutomatedBackupRequest)
Deletes automated backups using the
DbClusterResourceId value of the source DB cluster or the Amazon
Resource Name (ARN) of the automated backups. |
default DeleteDbClusterAutomatedBackupResponse |
deleteDBClusterAutomatedBackup(DeleteDbClusterAutomatedBackupRequest deleteDbClusterAutomatedBackupRequest)
Deletes automated backups using the
DbClusterResourceId value of the source DB cluster or the Amazon
Resource Name (ARN) of the automated backups. |
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.
|
default DeleteDbClusterParameterGroupResponse |
deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group.
|
default DeleteDbClusterParameterGroupResponse |
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)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
default DeleteDbInstanceResponse |
deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
default DeleteDbInstanceAutomatedBackupResponse |
deleteDBInstanceAutomatedBackup(Consumer<DeleteDbInstanceAutomatedBackupRequest.Builder> deleteDbInstanceAutomatedBackupRequest)
Deletes automated backups using the
DbiResourceId value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups. |
default DeleteDbInstanceAutomatedBackupResponse |
deleteDBInstanceAutomatedBackup(DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest)
Deletes automated backups using the
DbiResourceId value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups. |
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 a
DBProxyEndpoint . |
default DeleteDbProxyEndpointResponse |
deleteDBProxyEndpoint(DeleteDbProxyEndpointRequest deleteDbProxyEndpointRequest)
Deletes a
DBProxyEndpoint . |
default DeleteDbSecurityGroupResponse |
deleteDBSecurityGroup(Consumer<DeleteDbSecurityGroupRequest.Builder> deleteDbSecurityGroupRequest)
Deletes a DB security group.
|
default DeleteDbSecurityGroupResponse |
deleteDBSecurityGroup(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest)
Deletes a DB security 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 DeleteOptionGroupResponse |
deleteOptionGroup(Consumer<DeleteOptionGroupRequest.Builder> deleteOptionGroupRequest)
Deletes an existing option group.
|
default DeleteOptionGroupResponse |
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option group.
|
default DeregisterDbProxyTargetsResponse |
deregisterDBProxyTargets(Consumer<DeregisterDbProxyTargetsRequest.Builder> deregisterDbProxyTargetsRequest)
Remove the association between one or more
DBProxyTarget data structures and a
DBProxyTargetGroup . |
default DeregisterDbProxyTargetsResponse |
deregisterDBProxyTargets(DeregisterDbProxyTargetsRequest deregisterDbProxyTargetsRequest)
Remove the association between one or more
DBProxyTarget data structures and a
DBProxyTargetGroup . |
default DescribeAccountAttributesResponse |
describeAccountAttributes()
Lists all of the attributes for a customer account.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)
Lists all of the attributes for a customer account.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Lists all of the attributes for a customer account.
|
default DescribeBlueGreenDeploymentsResponse |
describeBlueGreenDeployments(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest)
Describes one or more blue/green deployments.
|
default DescribeBlueGreenDeploymentsResponse |
describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest)
Describes one or more blue/green deployments.
|
default DescribeBlueGreenDeploymentsIterable |
describeBlueGreenDeploymentsPaginator(Consumer<DescribeBlueGreenDeploymentsRequest.Builder> describeBlueGreenDeploymentsRequest)
Describes one or more blue/green deployments.
|
default DescribeBlueGreenDeploymentsIterable |
describeBlueGreenDeploymentsPaginator(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest)
Describes one or more blue/green deployments.
|
default DescribeCertificatesResponse |
describeCertificates()
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeCertificatesResponse |
describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeCertificatesResponse |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeCertificatesIterable |
describeCertificatesPaginator()
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeCertificatesIterable |
describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeCertificatesIterable |
describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
|
default DescribeDbClusterAutomatedBackupsResponse |
describeDBClusterAutomatedBackups(Consumer<DescribeDbClusterAutomatedBackupsRequest.Builder> describeDbClusterAutomatedBackupsRequest)
Displays backups for both current and deleted DB clusters.
|
default DescribeDbClusterAutomatedBackupsResponse |
describeDBClusterAutomatedBackups(DescribeDbClusterAutomatedBackupsRequest describeDbClusterAutomatedBackupsRequest)
Displays backups for both current and deleted DB clusters.
|
default DescribeDbClusterBacktracksResponse |
describeDBClusterBacktracks(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest)
Returns information about backtracks for a DB cluster.
|
default DescribeDbClusterBacktracksResponse |
describeDBClusterBacktracks(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest)
Returns information about backtracks for a DB cluster.
|
default DescribeDBClusterBacktracksIterable |
describeDBClusterBacktracksPaginator(Consumer<DescribeDbClusterBacktracksRequest.Builder> describeDbClusterBacktracksRequest)
Returns information about backtracks for a DB cluster.
|
default DescribeDBClusterBacktracksIterable |
describeDBClusterBacktracksPaginator(DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest)
Returns information about backtracks for a DB cluster.
|
default DescribeDbClusterEndpointsResponse |
describeDBClusterEndpoints()
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDbClusterEndpointsResponse |
describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest)
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDbClusterEndpointsResponse |
describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest)
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDBClusterEndpointsIterable |
describeDBClusterEndpointsPaginator()
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDBClusterEndpointsIterable |
describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest)
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDBClusterEndpointsIterable |
describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest)
Returns information about endpoints for an Amazon Aurora DB cluster.
|
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDBClusterParametersIterable |
describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDBClusterParametersIterable |
describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDbClustersResponse |
describeDBClusters()
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.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots()
Returns information about DB cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator()
Returns information about DB cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator()
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions()
Returns a list of the available DB engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator()
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDbInstanceAutomatedBackupsResponse |
describeDBInstanceAutomatedBackups()
Displays backups for both current and deleted instances.
|
default DescribeDbInstanceAutomatedBackupsResponse |
describeDBInstanceAutomatedBackups(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest)
Displays backups for both current and deleted instances.
|
default DescribeDbInstanceAutomatedBackupsResponse |
describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest)
Displays backups for both current and deleted instances.
|
default DescribeDBInstanceAutomatedBackupsIterable |
describeDBInstanceAutomatedBackupsPaginator()
Displays backups for both current and deleted instances.
|
default DescribeDBInstanceAutomatedBackupsIterable |
describeDBInstanceAutomatedBackupsPaginator(Consumer<DescribeDbInstanceAutomatedBackupsRequest.Builder> describeDbInstanceAutomatedBackupsRequest)
Displays backups for both current and deleted instances.
|
default DescribeDBInstanceAutomatedBackupsIterable |
describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest)
Displays backups for both current and deleted instances.
|
default DescribeDbInstancesResponse |
describeDBInstances()
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 |
describeDBInstancesPaginator()
Describes provisioned RDS instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Describes provisioned RDS instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Describes provisioned RDS instances.
|
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)
Returns a list of DB log files for the DB instance.
|
default DescribeDBLogFilesIterable |
describeDBLogFilesPaginator(DescribeDbLogFilesRequest describeDbLogFilesRequest)
Returns a list of DB log files for the DB instance.
|
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups()
Returns a list of
DBParameterGroup descriptions. |
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator()
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
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)
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDBParametersIterable |
describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
|
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)
Returns information about DB proxies.
|
default DescribeDBProxiesIterable |
describeDBProxiesPaginator(DescribeDbProxiesRequest describeDbProxiesRequest)
Returns information about DB proxies.
|
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)
Returns information about DB proxy endpoints.
|
default DescribeDBProxyEndpointsIterable |
describeDBProxyEndpointsPaginator(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest)
Returns information about DB proxy endpoints.
|
default DescribeDbProxyTargetGroupsResponse |
describeDBProxyTargetGroups(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest)
Returns information about DB proxy target groups, represented by
DBProxyTargetGroup data structures. |
default DescribeDbProxyTargetGroupsResponse |
describeDBProxyTargetGroups(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest)
Returns information about DB proxy target groups, represented by
DBProxyTargetGroup data structures. |
default DescribeDBProxyTargetGroupsIterable |
describeDBProxyTargetGroupsPaginator(Consumer<DescribeDbProxyTargetGroupsRequest.Builder> describeDbProxyTargetGroupsRequest)
Returns information about DB proxy target groups, represented by
DBProxyTargetGroup data structures. |
default DescribeDBProxyTargetGroupsIterable |
describeDBProxyTargetGroupsPaginator(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest)
Returns information about DB proxy target groups, represented by
DBProxyTargetGroup data structures. |
default DescribeDbProxyTargetsResponse |
describeDBProxyTargets(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest)
Returns information about
DBProxyTarget objects. |
default DescribeDbProxyTargetsResponse |
describeDBProxyTargets(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest)
Returns information about
DBProxyTarget objects. |
default DescribeDBProxyTargetsIterable |
describeDBProxyTargetsPaginator(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest)
Returns information about
DBProxyTarget objects. |
default DescribeDBProxyTargetsIterable |
describeDBProxyTargetsPaginator(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest)
Returns information about
DBProxyTarget objects. |
default DescribeDbSecurityGroupsResponse |
describeDBSecurityGroups()
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDbSecurityGroupsResponse |
describeDBSecurityGroups(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDbSecurityGroupsResponse |
describeDBSecurityGroups(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDBSecurityGroupsIterable |
describeDBSecurityGroupsPaginator()
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDBSecurityGroupsIterable |
describeDBSecurityGroupsPaginator(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDBSecurityGroupsIterable |
describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
default DescribeDbSnapshotAttributesResponse |
describeDBSnapshotAttributes(Consumer<DescribeDbSnapshotAttributesRequest.Builder> describeDbSnapshotAttributesRequest)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
|
default DescribeDbSnapshotAttributesResponse |
describeDBSnapshotAttributes(DescribeDbSnapshotAttributesRequest describeDbSnapshotAttributesRequest)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
|
default DescribeDbSnapshotsResponse |
describeDBSnapshots()
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 |
describeDBSnapshotsPaginator()
Returns information about DB snapshots.
|
default DescribeDBSnapshotsIterable |
describeDBSnapshotsPaginator(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest)
Returns information about DB snapshots.
|
default DescribeDBSnapshotsIterable |
describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest describeDbSnapshotsRequest)
Returns information about DB snapshots.
|
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups()
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 |
describeDBSubnetGroupsPaginator()
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEventCategoriesResponse |
describeEventCategories()
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 |
describeEvents()
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB
cluster snapshots, and RDS Proxies for the past 14 days.
|
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 |
describeEventsPaginator()
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 |
describeEventsPaginator(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 DescribeEventsIterable |
describeEventsPaginator(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 DescribeEventSubscriptionsResponse |
describeEventSubscriptions()
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator()
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
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)
Returns information about a snapshot or cluster export to Amazon S3.
|
default DescribeExportTasksIterable |
describeExportTasksPaginator(DescribeExportTasksRequest describeExportTasksRequest)
Returns information about a snapshot or cluster export to Amazon S3.
|
default DescribeGlobalClustersResponse |
describeGlobalClusters()
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 |
describeGlobalClustersPaginator()
Returns information about Aurora global database clusters.
|
default DescribeGlobalClustersIterable |
describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Aurora global database clusters.
|
default DescribeGlobalClustersIterable |
describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Aurora global database clusters.
|
default DescribeOptionGroupOptionsResponse |
describeOptionGroupOptions(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest)
Describes all available options.
|
default DescribeOptionGroupOptionsResponse |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
|
default DescribeOptionGroupOptionsIterable |
describeOptionGroupOptionsPaginator(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest)
Describes all available options.
|
default DescribeOptionGroupOptionsIterable |
describeOptionGroupOptionsPaginator(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
|
default DescribeOptionGroupsResponse |
describeOptionGroups()
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 |
describeOptionGroupsPaginator()
Describes the available option groups.
|
default DescribeOptionGroupsIterable |
describeOptionGroupsPaginator(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest)
Describes the available option groups.
|
default DescribeOptionGroupsIterable |
describeOptionGroupsPaginator(DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance
class.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance
class.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance
class.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance
class.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions()
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator()
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribeReservedDbInstancesResponse |
describeReservedDBInstances()
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDbInstancesResponse |
describeReservedDBInstances(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDbInstancesResponse |
describeReservedDBInstances(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDbInstancesOfferingsResponse |
describeReservedDBInstancesOfferings()
Lists available reserved DB instance offerings.
|
default DescribeReservedDbInstancesOfferingsResponse |
describeReservedDBInstancesOfferings(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
|
default DescribeReservedDbInstancesOfferingsResponse |
describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
|
default DescribeReservedDBInstancesOfferingsIterable |
describeReservedDBInstancesOfferingsPaginator()
Lists available reserved DB instance offerings.
|
default DescribeReservedDBInstancesOfferingsIterable |
describeReservedDBInstancesOfferingsPaginator(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
|
default DescribeReservedDBInstancesOfferingsIterable |
describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
|
default DescribeReservedDBInstancesIterable |
describeReservedDBInstancesPaginator()
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDBInstancesIterable |
describeReservedDBInstancesPaginator(Consumer<DescribeReservedDbInstancesRequest.Builder> describeReservedDbInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDBInstancesIterable |
describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeSourceRegionsResponse |
describeSourceRegions()
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create
a read replica, copy a DB snapshot from, or replicate automated backups from.
|
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 |
describeSourceRegionsPaginator()
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 |
describeSourceRegionsPaginator(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 DescribeSourceRegionsIterable |
describeSourceRegionsPaginator(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 DescribeValidDbInstanceModificationsResponse |
describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest)
You can call
DescribeValidDBInstanceModifications to learn what modifications you can make to your
DB instance. |
default DescribeValidDbInstanceModificationsResponse |
describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest)
You can call
DescribeValidDBInstanceModifications to learn what modifications you can make to your
DB instance. |
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)
Downloads all or a portion of the specified log file, up to 1 MB in size.
|
default DownloadDBLogFilePortionIterable |
downloadDBLogFilePortionPaginator(DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest)
Downloads all or a portion of the specified log file, up to 1 MB in size.
|
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)
Initiates the failover process for an Aurora global database (GlobalCluster).
|
default FailoverGlobalClusterResponse |
failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest)
Initiates the failover process for an Aurora global database (GlobalCluster).
|
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.
|
default ModifyCurrentDbClusterCapacityResponse |
modifyCurrentDBClusterCapacity(Consumer<ModifyCurrentDbClusterCapacityRequest.Builder> modifyCurrentDbClusterCapacityRequest)
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
|
default ModifyCurrentDbClusterCapacityResponse |
modifyCurrentDBClusterCapacity(ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest)
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
|
default ModifyCustomDbEngineVersionResponse |
modifyCustomDBEngineVersion(Consumer<ModifyCustomDbEngineVersionRequest.Builder> modifyCustomDbEngineVersionRequest)
Modifies the status of a custom engine version (CEV).
|
default ModifyCustomDbEngineVersionResponse |
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.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group.
|
default ModifyDbClusterSnapshotAttributeResponse |
modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
default ModifyDbClusterSnapshotAttributeResponse |
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 a
DBProxyTargetGroup . |
default ModifyDbProxyTargetGroupResponse |
modifyDBProxyTargetGroup(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest)
Modifies the properties of a
DBProxyTargetGroup . |
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.
|
default ModifyDbSnapshotAttributeResponse |
modifyDBSnapshotAttribute(Consumer<ModifyDbSnapshotAttributeRequest.Builder> modifyDbSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
|
default ModifyDbSnapshotAttributeResponse |
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 cluster.
|
default ModifyGlobalClusterResponse |
modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modifies a setting for an Amazon Aurora global cluster.
|
default ModifyOptionGroupResponse |
modifyOptionGroup(Consumer<ModifyOptionGroupRequest.Builder> modifyOptionGroupRequest)
Modifies an existing option group.
|
default ModifyOptionGroupResponse |
modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
Modifies an existing option group.
|
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.
|
default PromoteReadReplicaDbClusterResponse |
promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest)
Promotes a read replica DB cluster to a standalone DB cluster.
|
default PromoteReadReplicaDbClusterResponse |
promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest)
Promotes a read replica DB cluster to a standalone DB cluster.
|
default PurchaseReservedDbInstancesOfferingResponse |
purchaseReservedDBInstancesOffering(Consumer<PurchaseReservedDbInstancesOfferingRequest.Builder> purchaseReservedDbInstancesOfferingRequest)
Purchases a reserved DB instance offering.
|
default PurchaseReservedDbInstancesOfferingResponse |
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 RegisterDbProxyTargetsResponse |
registerDBProxyTargets(Consumer<RegisterDbProxyTargetsRequest.Builder> registerDbProxyTargetsRequest)
Associate one or more
DBProxyTarget data structures with a DBProxyTargetGroup . |
default RegisterDbProxyTargetsResponse |
registerDBProxyTargets(RegisterDbProxyTargetsRequest registerDbProxyTargetsRequest)
Associate one or more
DBProxyTarget data structures with a DBProxyTargetGroup . |
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.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing RDS event notification subscription.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
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.
|
default ResetDbClusterParameterGroupResponse |
resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value.
|
default ResetDbClusterParameterGroupResponse |
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.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.
|
default RestoreDbInstanceFromDbSnapshotResponse |
restoreDBInstanceFromDBSnapshot(Consumer<RestoreDbInstanceFromDbSnapshotRequest.Builder> restoreDbInstanceFromDbSnapshotRequest)
Creates a new DB instance from a DB snapshot.
|
default RestoreDbInstanceFromDbSnapshotResponse |
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.
|
default RestoreDbInstanceToPointInTimeResponse |
restoreDBInstanceToPointInTime(Consumer<RestoreDbInstanceToPointInTimeRequest.Builder> restoreDbInstanceToPointInTimeRequest)
Restores a DB instance to an arbitrary point in time.
|
default RestoreDbInstanceToPointInTimeResponse |
restoreDBInstanceToPointInTime(RestoreDbInstanceToPointInTimeRequest restoreDbInstanceToPointInTimeRequest)
Restores a DB instance to an arbitrary point in time.
|
default RevokeDbSecurityGroupIngressResponse |
revokeDBSecurityGroupIngress(Consumer<RevokeDbSecurityGroupIngressRequest.Builder> revokeDbSecurityGroupIngressRequest)
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.
|
default RevokeDbSecurityGroupIngressResponse |
revokeDBSecurityGroupIngress(RevokeDbSecurityGroupIngressRequest revokeDbSecurityGroupIngressRequest)
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.
|
default RdsServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
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 the StopDBCluster action.
|
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 the StopDBCluster action.
|
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 the StopDBInstance action.
|
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 the StopDBInstance action.
|
default StartDbInstanceAutomatedBackupsReplicationResponse |
startDBInstanceAutomatedBackupsReplication(Consumer<StartDbInstanceAutomatedBackupsReplicationRequest.Builder> startDbInstanceAutomatedBackupsReplicationRequest)
Enables replication of automated backups to a different Amazon Web Services Region.
|
default StartDbInstanceAutomatedBackupsReplicationResponse |
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, the
start-activity-stream CLI command, or the StartActivityStream action. |
default StopActivityStreamResponse |
stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest)
Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream CLI command, or the StartActivityStream action. |
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.
|
default StopDbInstanceAutomatedBackupsReplicationResponse |
stopDBInstanceAutomatedBackupsReplication(Consumer<StopDbInstanceAutomatedBackupsReplicationRequest.Builder> stopDbInstanceAutomatedBackupsReplicationRequest)
Stops automated backup replication for a DB instance.
|
default StopDbInstanceAutomatedBackupsReplicationResponse |
stopDBInstanceAutomatedBackupsReplication(StopDbInstanceAutomatedBackupsReplicationRequest stopDbInstanceAutomatedBackupsReplicationRequest)
Stops automated backup replication for a DB instance.
|
default SwitchoverBlueGreenDeploymentResponse |
switchoverBlueGreenDeployment(Consumer<SwitchoverBlueGreenDeploymentRequest.Builder> switchoverBlueGreenDeploymentRequest)
Switches over a blue/green deployment.
|
default SwitchoverBlueGreenDeploymentResponse |
switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest switchoverBlueGreenDeploymentRequest)
Switches over a blue/green deployment.
|
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 |
utilities()
Creates an instance of
RdsUtilities object with the configuration set on this client. |
default RdsWaiter |
waiter()
Create an instance of
RdsWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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.
addRoleToDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterRoleAlreadyExistsException
- The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterRoleQuotaExceededException
- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AddRoleToDbClusterRequest.builder()
addRoleToDbClusterRequest
- A Consumer
that will call methods on AddRoleToDBClusterMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterRoleAlreadyExistsException
- The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterRoleQuotaExceededException
- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
addRoleToDbInstanceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbInstanceRoleAlreadyExistsException
- The specified RoleArn
or FeatureName
value is already associated with the DB
instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceRoleQuotaExceededException
- You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB
instance because the quota has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AddRoleToDbInstanceRequest.builder()
addRoleToDbInstanceRequest
- A Consumer
that will call methods on AddRoleToDBInstanceMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbInstanceRoleAlreadyExistsException
- The specified RoleArn
or FeatureName
value is already associated with the DB
instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceRoleQuotaExceededException
- You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB
instance because the quota has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AddSourceIdentifierToSubscriptionRequest.builder()
addSourceIdentifierToSubscriptionRequest
- A Consumer
that will call methods on AddSourceIdentifierToSubscriptionMessage.Builder
to
create a request.SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, DbSnapshotNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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.
addTagsToResourceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbClusterNotFoundException, DbSnapshotNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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 via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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).
applyPendingMaintenanceActionRequest
- ResourceNotFoundException
- The specified resource ID was not found.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ApplyPendingMaintenanceActionRequest.builder()
applyPendingMaintenanceActionRequest
- A Consumer
that will call methods on ApplyPendingMaintenanceActionMessage.Builder
to
create a request.ResourceNotFoundException
- The specified resource ID was not found.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
authorizeDbSecurityGroupIngressRequest
- DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.AuthorizationAlreadyExistsException
- The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB
security group.AuthorizationQuotaExceededException
- The DB security group authorization quota has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AuthorizeDbSecurityGroupIngressRequest.builder()
authorizeDbSecurityGroupIngressRequest
- A Consumer
that will call methods on AuthorizeDBSecurityGroupIngressMessage.Builder
to
create a request.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.AuthorizationAlreadyExistsException
- The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB
security group.AuthorizationQuotaExceededException
- The DB security group authorization quota has been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
backtrackDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via BacktrackDbClusterRequest.builder()
backtrackDbClusterRequest
- A Consumer
that will call methods on BacktrackDBClusterMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
cancelExportTaskRequest
- ExportTaskNotFoundException
- The export task doesn't exist.InvalidExportTaskStateException
- You can't cancel an export task that has completed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CancelExportTaskRequest.builder()
cancelExportTaskRequest
- A Consumer
that will call methods on CancelExportTaskMessage.Builder
to create a request.ExportTaskNotFoundException
- The export task doesn't exist.InvalidExportTaskStateException
- You can't cancel an export task that has completed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException
Copies the specified DB cluster parameter group.
copyDbClusterParameterGroupRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException
Copies the specified DB cluster parameter group.
This is a convenience which creates an instance of the CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CopyDbClusterParameterGroupRequest.builder()
copyDbClusterParameterGroupRequest
- A Consumer
that will call methods on CopyDBClusterParameterGroupMessage.Builder
to create
a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the SourceDBClusterSnapshotIdentifier
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.
copyDbClusterSnapshotRequest
- DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the SourceDBClusterSnapshotIdentifier
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 via CopyDbClusterSnapshotRequest.builder()
copyDbClusterSnapshotRequest
- A Consumer
that will call methods on CopyDBClusterSnapshotMessage.Builder
to create a
request.DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Copies the specified DB parameter group.
copyDbParameterGroupRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbParameterGroupResponse copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Copies the specified DB parameter group.
This is a convenience which creates an instance of the CopyDbParameterGroupRequest.Builder
avoiding the
need to create one manually via CopyDbParameterGroupRequest.builder()
copyDbParameterGroupRequest
- A Consumer
that will call methods on CopyDBParameterGroupMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
copyDbSnapshotRequest
- DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CustomAvailabilityZoneNotFoundException
- CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CopyDbSnapshotRequest.builder()
copyDbSnapshotRequest
- A Consumer
that will call methods on CopyDBSnapshotMessage.Builder
to create a request.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CustomAvailabilityZoneNotFoundException
- CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyOptionGroupResponse copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Copies the specified option group.
copyOptionGroupRequest
- OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupNotFoundException
- The specified option group could not be found.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CopyOptionGroupRequest.builder()
copyOptionGroupRequest
- A Consumer
that will call methods on CopyOptionGroupMessage.Builder
to create a request.OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupNotFoundException
- The specified option group could not be found.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createBlueGreenDeploymentRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SourceDatabaseNotSupportedException
- The source DB instance isn't supported for a blue/green deployment.SourceClusterNotSupportedException
- The source DB cluster isn't supported for a blue/green deployment.BlueGreenDeploymentAlreadyExistsException
- A blue/green deployment with the specified name already exists.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateBlueGreenDeploymentRequest.builder()
createBlueGreenDeploymentRequest
- A Consumer
that will call methods on CreateBlueGreenDeploymentRequest.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SourceDatabaseNotSupportedException
- The source DB instance isn't supported for a blue/green deployment.SourceClusterNotSupportedException
- The source DB cluster isn't supported for a blue/green deployment.BlueGreenDeploymentAlreadyExistsException
- A blue/green deployment with the specified name already exists.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCustomDbEngineVersionResponse createCustomDBEngineVersion(CreateCustomDbEngineVersionRequest createCustomDbEngineVersionRequest) throws CustomDbEngineVersionAlreadyExistsException, CustomDbEngineVersionQuotaExceededException, Ec2ImagePropertiesNotSupportedException, KmsKeyNotAccessibleException, CreateCustomDbEngineVersionException, AwsServiceException, SdkClientException, RdsException
Creates a custom DB engine version (CEV).
createCustomDbEngineVersionRequest
- CustomDbEngineVersionAlreadyExistsException
- A CEV with the specified name already exists.CustomDbEngineVersionQuotaExceededException
- You have exceeded your CEV quota.Ec2ImagePropertiesNotSupportedException
- The AMI configuration prerequisite has not been met.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CreateCustomDbEngineVersionException
- An error occurred while trying to create the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateCustomDbEngineVersionRequest.builder()
createCustomDbEngineVersionRequest
- A Consumer
that will call methods on CreateCustomDBEngineVersionMessage.Builder
to create
a request.CustomDbEngineVersionAlreadyExistsException
- A CEV with the specified name already exists.CustomDbEngineVersionQuotaExceededException
- You have exceeded your CEV quota.Ec2ImagePropertiesNotSupportedException
- The AMI configuration prerequisite has not been met.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CreateCustomDbEngineVersionException
- An error occurred while trying to create the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DomainNotFoundException, 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.
createDbClusterRequest
- DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DomainNotFoundException, 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 via CreateDbClusterRequest.builder()
createDbClusterRequest
- A Consumer
that will call methods on CreateDBClusterMessage.Builder
to create a request.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDbClusterEndpointRequest
- DbClusterEndpointQuotaExceededException
- The cluster already has the maximum number of custom endpoints.DbClusterEndpointAlreadyExistsException
- The specified custom endpoint can't be created because it already exists.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbClusterEndpointRequest.builder()
createDbClusterEndpointRequest
- A Consumer
that will call methods on CreateDBClusterEndpointMessage.Builder
to create a
request.DbClusterEndpointQuotaExceededException
- The cluster already has the maximum number of custom endpoints.DbClusterEndpointAlreadyExistsException
- The specified custom endpoint can't be created because it already exists.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 using ModifyDBCluster
.
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 the DescribeDBClusterParameters
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.
createDbClusterParameterGroupRequest
- DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 using ModifyDBCluster
.
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 the DescribeDBClusterParameters
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 via CreateDbClusterParameterGroupRequest.builder()
createDbClusterParameterGroupRequest
- A Consumer
that will call methods on CreateDBClusterParameterGroupMessage.Builder
to
create a request.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDbClusterSnapshotRequest
- DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbClusterSnapshotRequest.builder()
createDbClusterSnapshotRequest
- A Consumer
that will call methods on CreateDBClusterSnapshotMessage.Builder
to create a
request.DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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.
createDbInstanceRequest
- DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 via CreateDbInstanceRequest.builder()
createDbInstanceRequest
- A Consumer
that will call methods on CreateDBInstanceMessage.Builder
to create a request.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 MySQL, MariaDB, 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. Call the CreateDBInstance
operation to create a DB
instance for an Aurora DB cluster.
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.
createDbInstanceReadReplicaRequest
- DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbSubnetGroupNotAllowedException
- The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
source instance.InvalidDbSubnetGroupException
- The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
same source instance.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 MySQL, MariaDB, 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. Call the CreateDBInstance
operation to create a DB
instance for an Aurora DB cluster.
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 via CreateDbInstanceReadReplicaRequest.builder()
createDbInstanceReadReplicaRequest
- A Consumer
that will call methods on CreateDBInstanceReadReplicaMessage.Builder
to create
a request.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbSubnetGroupNotAllowedException
- The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
source instance.InvalidDbSubnetGroupException
- The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
same source instance.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 using ModifyDBInstance
. 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.
createDbParameterGroupRequest
- DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 using ModifyDBInstance
. 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 via CreateDbParameterGroupRequest.builder()
createDbParameterGroupRequest
- A Consumer
that will call methods on CreateDBParameterGroupMessage.Builder
to create a
request.DbParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbProxyResponse createDBProxy(CreateDbProxyRequest createDbProxyRequest) throws InvalidSubnetException, DbProxyAlreadyExistsException, DbProxyQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Creates a new DB proxy.
createDbProxyRequest
- InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyQuotaExceededException
- Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web
Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbProxyRequest.builder()
createDbProxyRequest
- A Consumer
that will call methods on CreateDBProxyRequest.Builder
to create a request.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyQuotaExceededException
- Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web
Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDbProxyEndpointRequest
- InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyEndpointQuotaExceededException
- The DB proxy already has the maximum number of endpoints.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbProxyEndpointRequest.builder()
createDbProxyEndpointRequest
- A Consumer
that will call methods on CreateDBProxyEndpointRequest.Builder
to create a
request.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyEndpointQuotaExceededException
- The DB proxy already has the maximum number of endpoints.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDbSecurityGroupRequest
- DbSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName
already exists.DbSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB security groups.DbSecurityGroupNotSupportedException
- A DB security group isn't allowed for this action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbSecurityGroupRequest.builder()
createDbSecurityGroupRequest
- A Consumer
that will call methods on CreateDBSecurityGroupMessage.Builder
to create a
request.DbSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName
already exists.DbSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB security groups.DbSecurityGroupNotSupportedException
- A DB security group isn't allowed for this action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
or
storage-optimization
state.
createDbSnapshotRequest
- DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
or
storage-optimization
state.
This is a convenience which creates an instance of the CreateDbSnapshotRequest.Builder
avoiding the need
to create one manually via CreateDbSnapshotRequest.builder()
createDbSnapshotRequest
- A Consumer
that will call methods on CreateDBSnapshotMessage.Builder
to create a request.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDbSubnetGroupRequest
- DbSubnetGroupAlreadyExistsException
- DBSubnetGroupName
is already used by an existing DB subnet group.DbSubnetGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB subnet groups.DbSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateDbSubnetGroupRequest.builder()
createDbSubnetGroupRequest
- A Consumer
that will call methods on CreateDBSubnetGroupMessage.Builder
to create a
request.DbSubnetGroupAlreadyExistsException
- DBSubnetGroupName
is already used by an existing DB subnet group.DbSubnetGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB subnet groups.DbSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 specify
SourceType
= db-instance
, SourceIds
= mydbinstance1
,
mydbinstance2
and EventCategories
= Availability
, Backup
.
If you specify both the SourceType
and SourceIds
, such as SourceType
=
db-instance
and SourceIds
= myDBInstance1
, you are notified of all the
db-instance
events for the specified source. If you specify a SourceType
but do not
specify SourceIds
, you receive notice of the events for that source type for all your RDS sources.
If you don't specify either the SourceType or the SourceIds
, 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.
createEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException
- The supplied subscription name already exists.SnsInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SnsNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SnsTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 specify
SourceType
= db-instance
, SourceIds
= mydbinstance1
,
mydbinstance2
and EventCategories
= Availability
, Backup
.
If you specify both the SourceType
and SourceIds
, such as SourceType
=
db-instance
and SourceIds
= myDBInstance1
, you are notified of all the
db-instance
events for the specified source. If you specify a SourceType
but do not
specify SourceIds
, you receive notice of the events for that source type for all your RDS sources.
If you don't specify either the SourceType or the SourceIds
, 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 via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest
- A Consumer
that will call methods on CreateEventSubscriptionMessage.Builder
to create a
request.EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException
- The supplied subscription name already exists.SnsInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SnsNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SnsTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createGlobalClusterRequest
- GlobalClusterAlreadyExistsException
- The GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique
name) to create a new global database cluster.GlobalClusterQuotaExceededException
- The number of global database clusters for this account is already at the maximum allowed.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateGlobalClusterRequest.builder()
createGlobalClusterRequest
- A Consumer
that will call methods on CreateGlobalClusterMessage.Builder
to create a
request.GlobalClusterAlreadyExistsException
- The GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique
name) to create a new global database cluster.GlobalClusterQuotaExceededException
- The number of global database clusters for this account is already at the maximum allowed.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createOptionGroupRequest
- OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateOptionGroupRequest.builder()
createOptionGroupRequest
- A Consumer
that will call methods on CreateOptionGroupMessage.Builder
to create a request.OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteBlueGreenDeploymentRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteBlueGreenDeploymentRequest.builder()
deleteBlueGreenDeploymentRequest
- A Consumer
that will call methods on DeleteBlueGreenDeploymentRequest.Builder
to create a
request.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
DeleteCustomDbEngineVersion
event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
deleteCustomDbEngineVersionRequest
- CustomDbEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDbEngineVersionStateException
- You can't delete the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
DeleteCustomDbEngineVersion
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 via DeleteCustomDbEngineVersionRequest.builder()
deleteCustomDbEngineVersionRequest
- A Consumer
that will call methods on DeleteCustomDBEngineVersionMessage.Builder
to create
a request.CustomDbEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDbEngineVersionStateException
- You can't delete the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DbClusterAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB cluster quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbClusterRequest.builder()
deleteDbClusterRequest
- A Consumer
that will call methods on DeleteDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DbClusterAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB cluster quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbClusterAutomatedBackupRequest
- InvalidDbClusterAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active cluster.DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbClusterAutomatedBackupRequest.builder()
deleteDbClusterAutomatedBackupRequest
- A Consumer
that will call methods on DeleteDBClusterAutomatedBackupMessage.Builder
to
create a request.InvalidDbClusterAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active cluster.DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbClusterEndpointRequest
- InvalidDbClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbClusterEndpointRequest.builder()
deleteDbClusterEndpointRequest
- A Consumer
that will call methods on DeleteDBClusterEndpointMessage.Builder
to create a
request.InvalidDbClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbClusterParameterGroupRequest
- InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbClusterParameterGroupRequest.builder()
deleteDbClusterParameterGroupRequest
- A Consumer
that will call methods on DeleteDBClusterParameterGroupMessage.Builder
to
create a request.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbClusterSnapshotRequest
- InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbClusterSnapshotRequest.builder()
deleteDbClusterSnapshotRequest
- A Consumer
that will call methods on DeleteDBClusterSnapshotMessage.Builder
to create a
request.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException
The DeleteDBInstance action 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. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance
are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting
until the DB
snapshot is created. The API action DescribeDBInstance
is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot
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 call the PromoteReadReplicaDBCluster
API action to
promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB cluster.
deleteDbInstanceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException, AwsServiceException, SdkClientException, RdsException
The DeleteDBInstance action 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. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance
are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting
until the DB
snapshot is created. The API action DescribeDBInstance
is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot
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 call the PromoteReadReplicaDBCluster
API action to
promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB cluster.
This is a convenience which creates an instance of the DeleteDbInstanceRequest.Builder
avoiding the need
to create one manually via DeleteDbInstanceRequest.builder()
deleteDbInstanceRequest
- A Consumer
that will call methods on DeleteDBInstanceMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbInstanceAutomatedBackupRequest
- Parameter input for the DeleteDBInstanceAutomatedBackup
operation.InvalidDbInstanceAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active instance.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbInstanceAutomatedBackupRequest.builder()
deleteDbInstanceAutomatedBackupRequest
- A Consumer
that will call methods on DeleteDBInstanceAutomatedBackupMessage.Builder
to
create a request. Parameter input for the DeleteDBInstanceAutomatedBackup
operation.InvalidDbInstanceAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active instance.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbParameterGroupRequest
- InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbParameterGroupRequest.builder()
deleteDbParameterGroupRequest
- A Consumer
that will call methods on DeleteDBParameterGroupMessage.Builder
to create a
request.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbProxyResponse deleteDBProxy(DeleteDbProxyRequest deleteDbProxyRequest) throws DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Deletes an existing DB proxy.
deleteDbProxyRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbProxyRequest.builder()
deleteDbProxyRequest
- A Consumer
that will call methods on DeleteDBProxyRequest.Builder
to create a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbProxyEndpointRequest
- DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.InvalidDbProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbProxyEndpointRequest.builder()
deleteDbProxyEndpointRequest
- A Consumer
that will call methods on DeleteDBProxyEndpointRequest.Builder
to create a
request.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.InvalidDbProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbSecurityGroupRequest
- InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbSecurityGroupRequest.builder()
deleteDbSecurityGroupRequest
- A Consumer
that will call methods on DeleteDBSecurityGroupMessage.Builder
to create a
request.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbSnapshotRequest
- InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbSnapshotRequest.builder()
deleteDbSnapshotRequest
- A Consumer
that will call methods on DeleteDBSnapshotMessage.Builder
to create a request.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDbSubnetGroupRequest
- InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidDbSubnetStateException
- The DB subnet isn't in the available state.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDbSubnetGroupRequest.builder()
deleteDbSubnetGroupRequest
- A Consumer
that will call methods on DeleteDBSubnetGroupMessage.Builder
to create a
request.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidDbSubnetStateException
- The DB subnet isn't in the available state.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, RdsException
Deletes an RDS event notification subscription.
deleteEventSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.InvalidEventSubscriptionStateException
- This error can occur if someone else is modifying a subscription. You should retry the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest
- A Consumer
that will call methods on DeleteEventSubscriptionMessage.Builder
to create a
request.SubscriptionNotFoundException
- The subscription name does not exist.InvalidEventSubscriptionStateException
- This error can occur if someone else is modifying a subscription. You should retry the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteGlobalClusterRequest.builder()
deleteGlobalClusterRequest
- A Consumer
that will call methods on DeleteGlobalClusterMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteOptionGroupResponse deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) throws OptionGroupNotFoundException, InvalidOptionGroupStateException, AwsServiceException, SdkClientException, RdsException
Deletes an existing option group.
deleteOptionGroupRequest
- OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group isn't in the available state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteOptionGroupRequest.builder()
deleteOptionGroupRequest
- A Consumer
that will call methods on DeleteOptionGroupMessage.Builder
to create a request.OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group isn't in the available state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterDbProxyTargetsResponse deregisterDBProxyTargets(DeregisterDbProxyTargetsRequest deregisterDbProxyTargetsRequest) throws DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, DbProxyNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Remove the association between one or more DBProxyTarget
data structures and a
DBProxyTargetGroup
.
deregisterDbProxyTargetsRequest
- DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 a
DBProxyTargetGroup
.
This is a convenience which creates an instance of the DeregisterDbProxyTargetsRequest.Builder
avoiding
the need to create one manually via DeregisterDbProxyTargetsRequest.builder()
deregisterDbProxyTargetsRequest
- A Consumer
that will call methods on DeregisterDBProxyTargetsRequest.Builder
to create a
request.DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeAccountAttributesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeAccountAttributesRequest.builder()
describeAccountAttributesRequest
- A Consumer
that will call methods on DescribeAccountAttributesMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAccountAttributesResponse describeAccountAttributes() 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAccountAttributes(DescribeAccountAttributesRequest)
,
AWS
API Documentationdefault 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.
describeBlueGreenDeploymentsRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeBlueGreenDeploymentsRequest.builder()
describeBlueGreenDeploymentsRequest
- A Consumer
that will call methods on DescribeBlueGreenDeploymentsRequest.Builder
to create
a request.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeBlueGreenDeploymentsIterable describeBlueGreenDeploymentsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeBlueGreenDeploymentsRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeBlueGreenDeploymentsIterable describeBlueGreenDeploymentsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeBlueGreenDeploymentsIterable responses = client.describeBlueGreenDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeBlueGreenDeploymentsRequest.builder()
describeBlueGreenDeploymentsRequest
- A Consumer
that will call methods on DescribeBlueGreenDeploymentsRequest.Builder
to create
a request.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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.
describeCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCertificatesResponse describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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 via DescribeCertificatesRequest.builder()
describeCertificatesRequest
- A Consumer
that will call methods on DescribeCertificatesMessage.Builder
to create a
request.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCertificatesResponse describeCertificates() throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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.
CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeCertificates(DescribeCertificatesRequest)
,
AWS API
Documentationdefault DescribeCertificatesIterable describeCertificatesPaginator() throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeCertificatesPaginator(DescribeCertificatesRequest)
,
AWS API
Documentationdefault DescribeCertificatesIterable describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCertificatesIterable describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeCertificatesRequest.builder()
describeCertificatesRequest
- A Consumer
that will call methods on DescribeCertificatesMessage.Builder
to create a
request.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and DescribeDBClusters
operations.
All parameters are optional.
describeDbClusterAutomatedBackupsRequest
- DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and DescribeDBClusters
operations.
All parameters are optional.
This is a convenience which creates an instance of the DescribeDbClusterAutomatedBackupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterAutomatedBackupsRequest.builder()
describeDbClusterAutomatedBackupsRequest
- A Consumer
that will call methods on DescribeDBClusterAutomatedBackupsMessage.Builder
to
create a request.DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbClusterBacktracksRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterBacktrackNotFoundException
- BacktrackIdentifier
doesn't refer to an existing backtrack.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbClusterBacktracksRequest.builder()
describeDbClusterBacktracksRequest
- A Consumer
that will call methods on DescribeDBClusterBacktracksMessage.Builder
to create
a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterBacktrackNotFoundException
- BacktrackIdentifier
doesn't refer to an existing backtrack.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterBacktracksIterable describeDBClusterBacktracksPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClusterBacktracksRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterBacktrackNotFoundException
- BacktrackIdentifier
doesn't refer to an existing backtrack.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterBacktracksIterable describeDBClusterBacktracksPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterBacktracksIterable responses = client.describeDBClusterBacktracksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClusterBacktracksRequest.builder()
describeDbClusterBacktracksRequest
- A Consumer
that will call methods on DescribeDBClusterBacktracksMessage.Builder
to create
a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterBacktrackNotFoundException
- BacktrackIdentifier
doesn't refer to an existing backtrack.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbClusterEndpointsRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbClusterEndpointsRequest.builder()
describeDbClusterEndpointsRequest
- A Consumer
that will call methods on DescribeDBClusterEndpointsMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest)
,
AWS API Documentationdefault DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest)
,
AWS API Documentationdefault DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClusterEndpointsRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClusterEndpointsRequest.builder()
describeDbClusterEndpointsRequest
- A Consumer
that will call methods on DescribeDBClusterEndpointsMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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.
describeDbClusterParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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 via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBClusterParameterGroupsMessage.Builder
to
create a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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.
DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest)
,
AWS API Documentationdefault DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest)
,
AWS API Documentationdefault DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClusterParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBClusterParameterGroupsMessage.Builder
to
create a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbClusterParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest
- A Consumer
that will call methods on DescribeDBClusterParametersMessage.Builder
to create
a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClusterParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest
- A Consumer
that will call methods on DescribeDBClusterParametersMessage.Builder
to create
a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the restore
attribute and a list of IDs for the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If all
is included in the list of
values for the restore
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.
describeDbClusterSnapshotAttributesRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the restore
attribute and a list of IDs for the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If all
is included in the list of
values for the restore
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 via DescribeDbClusterSnapshotAttributesRequest.builder()
describeDbClusterSnapshotAttributesRequest
- A Consumer
that will call methods on DescribeDBClusterSnapshotAttributesMessage.Builder
to
create a request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbClusterSnapshotsRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest
- A Consumer
that will call methods on DescribeDBClusterSnapshotsMessage.Builder
to create a
request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() 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.
DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest)
,
AWS API Documentationdefault DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest)
,
AWS API Documentationdefault DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClusterSnapshotsRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest
- A Consumer
that will call methods on DescribeDBClusterSnapshotsMessage.Builder
to create a
request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbClustersRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbClustersRequest.builder()
describeDbClustersRequest
- A Consumer
that will call methods on DescribeDBClustersMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClustersResponse describeDBClusters() 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.
DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusters(DescribeDbClustersRequest)
,
AWS API
Documentationdefault DescribeDBClustersIterable describeDBClustersPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClustersPaginator(DescribeDbClustersRequest)
,
AWS API
Documentationdefault DescribeDBClustersIterable describeDBClustersPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbClustersRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBClustersIterable describeDBClustersPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbClustersRequest.builder()
describeDbClustersRequest
- A Consumer
that will call methods on DescribeDBClustersMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
describeDbEngineVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder
avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest
- A Consumer
that will call methods on DescribeDBEngineVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBEngineVersions(DescribeDbEngineVersionsRequest)
,
AWS
API Documentationdefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest)
,
AWS
API Documentationdefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbEngineVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of the available DB engines.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest
- A Consumer
that will call methods on DescribeDBEngineVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and
DescribeDBInstances
operations.
All parameters are optional.
describeDbInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and
DescribeDBInstances
operations.
All parameters are optional.
This is a convenience which creates an instance of the DescribeDbInstanceAutomatedBackupsRequest.Builder
avoiding the need to create one manually via DescribeDbInstanceAutomatedBackupsRequest.builder()
describeDbInstanceAutomatedBackupsRequest
- A Consumer
that will call methods on DescribeDBInstanceAutomatedBackupsMessage.Builder
to
create a request. Parameter input for DescribeDBInstanceAutomatedBackups.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups() 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
and
DescribeDBInstances
operations.
All parameters are optional.
DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest)
,
AWS API Documentationdefault DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator() 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
and
DescribeDBInstances
operations.
All parameters are optional.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest)
,
AWS API Documentationdefault DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(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
and
DescribeDBInstances
operations.
All parameters are optional.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(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
and
DescribeDBInstances
operations.
All parameters are optional.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable responses = client.describeDBInstanceAutomatedBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbInstanceAutomatedBackupsRequest.builder()
describeDbInstanceAutomatedBackupsRequest
- A Consumer
that will call methods on DescribeDBInstanceAutomatedBackupsMessage.Builder
to
create a request. Parameter input for DescribeDBInstanceAutomatedBackups.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbInstancesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest
- A Consumer
that will call methods on DescribeDBInstancesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbInstancesResponse describeDBInstances() 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.
DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstances(DescribeDbInstancesRequest)
,
AWS API
Documentationdefault DescribeDBInstancesIterable describeDBInstancesPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstancesPaginator(DescribeDbInstancesRequest)
,
AWS API
Documentationdefault DescribeDBInstancesIterable describeDBInstancesPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbInstancesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBInstancesIterable describeDBInstancesPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest
- A Consumer
that will call methods on DescribeDBInstancesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbLogFilesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbLogFilesRequest.builder()
describeDbLogFilesRequest
- A Consumer
that will call methods on DescribeDBLogFilesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbLogFilesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable responses = client.describeDBLogFilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbLogFilesRequest.builder()
describeDbLogFilesRequest
- A Consumer
that will call methods on DescribeDBLogFilesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParameterGroupsResponse describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
describeDbParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParameterGroupsResponse describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
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 via DescribeDbParameterGroupsRequest.builder()
describeDbParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBParameterGroupsMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBParameterGroups(DescribeDbParameterGroupsRequest)
,
AWS
API Documentationdefault DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest)
,
AWS
API Documentationdefault DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbParameterGroupsRequest.builder()
describeDbParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBParameterGroupsMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns the detailed parameter list for a particular DB parameter group.
describeDbParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbParametersRequest.builder()
describeDbParametersRequest
- A Consumer
that will call methods on DescribeDBParametersMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns the detailed parameter list for a particular DB parameter group.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParametersIterable describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns the detailed parameter list for a particular DB parameter group.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbParametersRequest.builder()
describeDbParametersRequest
- A Consumer
that will call methods on DescribeDBParametersMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbProxiesResponse describeDBProxies(DescribeDbProxiesRequest describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxies.
describeDbProxiesRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbProxiesRequest.builder()
describeDbProxiesRequest
- A Consumer
that will call methods on DescribeDBProxiesRequest.Builder
to create a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxiesIterable describeDBProxiesPaginator(DescribeDbProxiesRequest describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxies.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbProxiesRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxiesIterable describeDBProxiesPaginator(Consumer<DescribeDbProxiesRequest.Builder> describeDbProxiesRequest) throws DbProxyNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxies.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxiesIterable responses = client.describeDBProxiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbProxiesRequest.builder()
describeDbProxiesRequest
- A Consumer
that will call methods on DescribeDBProxiesRequest.Builder
to create a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbProxyEndpointsResponse describeDBProxyEndpoints(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxy endpoints.
describeDbProxyEndpointsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbProxyEndpointsRequest.builder()
describeDbProxyEndpointsRequest
- A Consumer
that will call methods on DescribeDBProxyEndpointsRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyEndpointsIterable describeDBProxyEndpointsPaginator(DescribeDbProxyEndpointsRequest describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxy endpoints.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbProxyEndpointsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyEndpointsIterable describeDBProxyEndpointsPaginator(Consumer<DescribeDbProxyEndpointsRequest.Builder> describeDbProxyEndpointsRequest) throws DbProxyNotFoundException, DbProxyEndpointNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxy endpoints.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyEndpointsIterable responses = client.describeDBProxyEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbProxyEndpointsRequest.builder()
describeDbProxyEndpointsRequest
- A Consumer
that will call methods on DescribeDBProxyEndpointsRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbProxyTargetGroupsResponse describeDBProxyTargetGroups(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
describeDbProxyTargetGroupsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbProxyTargetGroupsRequest.builder()
describeDbProxyTargetGroupsRequest
- A Consumer
that will call methods on DescribeDBProxyTargetGroupsRequest.Builder
to create
a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyTargetGroupsIterable describeDBProxyTargetGroupsPaginator(DescribeDbProxyTargetGroupsRequest describeDbProxyTargetGroupsRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbProxyTargetGroupsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyTargetGroupsIterable describeDBProxyTargetGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetGroupsIterable responses = client.describeDBProxyTargetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbProxyTargetGroupsRequest.builder()
describeDbProxyTargetGroupsRequest
- A Consumer
that will call methods on DescribeDBProxyTargetGroupsRequest.Builder
to create
a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbProxyTargetsResponse describeDBProxyTargets(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Returns information about DBProxyTarget
objects. This API supports pagination.
describeDbProxyTargetsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbProxyTargetsRequest.builder()
describeDbProxyTargetsRequest
- A Consumer
that will call methods on DescribeDBProxyTargetsRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyTargetsIterable describeDBProxyTargetsPaginator(DescribeDbProxyTargetsRequest describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Returns information about DBProxyTarget
objects. This API supports pagination.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbProxyTargetsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBProxyTargetsIterable describeDBProxyTargetsPaginator(Consumer<DescribeDbProxyTargetsRequest.Builder> describeDbProxyTargetsRequest) throws DbProxyNotFoundException, DbProxyTargetNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Returns information about DBProxyTarget
objects. This API supports pagination.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBProxyTargetsIterable responses = client.describeDBProxyTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbProxyTargetsRequest.builder()
describeDbProxyTargetsRequest
- A Consumer
that will call methods on DescribeDBProxyTargetsRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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.
describeDbSecurityGroupsRequest
- DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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 via DescribeDbSecurityGroupsRequest.builder()
describeDbSecurityGroupsRequest
- A Consumer
that will call methods on DescribeDBSecurityGroupsMessage.Builder
to create a
request.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups() throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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.
DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSecurityGroups(DescribeDbSecurityGroupsRequest)
,
AWS
API Documentationdefault DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator() throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest)
,
AWS
API Documentationdefault DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbSecurityGroupsRequest
- DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(Consumer<DescribeDbSecurityGroupsRequest.Builder> describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable responses = client.describeDBSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbSecurityGroupsRequest.builder()
describeDbSecurityGroupsRequest
- A Consumer
that will call methods on DescribeDBSecurityGroupsMessage.Builder
to create a
request.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the restore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to
copy or restore the manual DB snapshot. If all
is included in the list of values for the
restore
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.
describeDbSnapshotAttributesRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the restore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to
copy or restore the manual DB snapshot. If all
is included in the list of values for the
restore
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 via DescribeDbSnapshotAttributesRequest.builder()
describeDbSnapshotAttributesRequest
- A Consumer
that will call methods on DescribeDBSnapshotAttributesMessage.Builder
to create
a request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSnapshotsResponse describeDBSnapshots(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB snapshots. This API action supports pagination.
describeDbSnapshotsRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbSnapshotsRequest.builder()
describeDbSnapshotsRequest
- A Consumer
that will call methods on DescribeDBSnapshotsMessage.Builder
to create a
request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSnapshotsResponse describeDBSnapshots() throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB snapshots. This API action supports pagination.
DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSnapshots(DescribeDbSnapshotsRequest)
,
AWS API
Documentationdefault DescribeDBSnapshotsIterable describeDBSnapshotsPaginator() throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB snapshots. This API action supports pagination.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest)
,
AWS API
Documentationdefault DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB snapshots. This API action supports pagination.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbSnapshotsRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(Consumer<DescribeDbSnapshotsRequest.Builder> describeDbSnapshotsRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB snapshots. This API action supports pagination.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable responses = client.describeDBSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbSnapshotsRequest.builder()
describeDbSnapshotsRequest
- A Consumer
that will call methods on DescribeDBSnapshotsMessage.Builder
to create a
request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeDbSubnetGroupsRequest
- DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest
- A Consumer
that will call methods on DescribeDBSubnetGroupsMessage.Builder
to create a
request.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() 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.
DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest)
,
AWS
API Documentationdefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest)
,
AWS
API Documentationdefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeDbSubnetGroupsRequest
- DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest
- A Consumer
that will call methods on DescribeDBSubnetGroupsMessage.Builder
to create a
request.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeEngineDefaultClusterParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
DescribeEngineDefaultClusterParametersRequest.builder()
describeEngineDefaultClusterParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultClusterParametersMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException
Returns the default engine and system parameter information for the specified database engine.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeEngineDefaultParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, RdsException
Returns the default engine and system parameter information for the specified database engine.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 .
describeEventCategoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest
- A Consumer
that will call methods on DescribeEventCategoriesMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventCategoriesResponse describeEventCategories() 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 .
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventCategories(DescribeEventCategoriesRequest)
,
AWS
API Documentationdefault 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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsResponse describeEventSubscriptions() 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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptions(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() 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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(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
, and Status
.
If you specify a SubscriptionName
, lists the description for that subscription.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
- The subscription name does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents() 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEvents(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventsPaginator(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeExportTasksRequest
- ExportTaskNotFoundException
- The export task doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeExportTasksRequest.builder()
describeExportTasksRequest
- A Consumer
that will call methods on DescribeExportTasksMessage.Builder
to create a
request.ExportTaskNotFoundException
- The export task doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeExportTasksIterable describeExportTasksPaginator(DescribeExportTasksRequest 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeExportTasksRequest
- ExportTaskNotFoundException
- The export task doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeExportTasksIterable describeExportTasksPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeExportTasksIterable responses = client.describeExportTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeExportTasksRequest.builder()
describeExportTasksRequest
- A Consumer
that will call methods on DescribeExportTasksMessage.Builder
to create a
request.ExportTaskNotFoundException
- The export task doesn't exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeGlobalClustersRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest
- A Consumer
that will call methods on DescribeGlobalClustersMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeGlobalClustersResponse describeGlobalClusters() 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.
GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeGlobalClusters(DescribeGlobalClustersRequest)
,
AWS
API Documentationdefault DescribeGlobalClustersIterable describeGlobalClustersPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeGlobalClustersPaginator(DescribeGlobalClustersRequest)
,
AWS
API Documentationdefault DescribeGlobalClustersIterable describeGlobalClustersPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeGlobalClustersRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest
- A Consumer
that will call methods on DescribeGlobalClustersMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Describes all available options.
describeOptionGroupOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Describes all available options.
This is a convenience which creates an instance of the DescribeOptionGroupOptionsRequest.Builder
avoiding
the need to create one manually via DescribeOptionGroupOptionsRequest.builder()
describeOptionGroupOptionsRequest
- A Consumer
that will call methods on DescribeOptionGroupOptionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Describes all available options.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeOptionGroupOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(Consumer<DescribeOptionGroupOptionsRequest.Builder> describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Describes all available options.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable responses = client.describeOptionGroupOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeOptionGroupOptionsRequest.builder()
describeOptionGroupOptionsRequest
- A Consumer
that will call methods on DescribeOptionGroupOptionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupsResponse describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Describes the available option groups.
describeOptionGroupsRequest
- OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeOptionGroupsRequest.builder()
describeOptionGroupsRequest
- A Consumer
that will call methods on DescribeOptionGroupsMessage.Builder
to create a
request.OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupsResponse describeOptionGroups() throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Describes the available option groups.
OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeOptionGroups(DescribeOptionGroupsRequest)
,
AWS API
Documentationdefault DescribeOptionGroupsIterable describeOptionGroupsPaginator() throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Describes the available option groups.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeOptionGroupsPaginator(DescribeOptionGroupsRequest)
,
AWS API
Documentationdefault DescribeOptionGroupsIterable describeOptionGroupsPaginator(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Describes the available option groups.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeOptionGroupsRequest
- OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOptionGroupsIterable describeOptionGroupsPaginator(Consumer<DescribeOptionGroupsRequest.Builder> describeOptionGroupsRequest) throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Describes the available option groups.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable responses = client.describeOptionGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeOptionGroupsRequest.builder()
describeOptionGroupsRequest
- A Consumer
that will call methods on DescribeOptionGroupsMessage.Builder
to create a
request.OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
describeOrderableDbInstanceOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest
- A Consumer
that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeOrderableDbInstanceOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest
- A Consumer
that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest
- A Consumer
that will call methods on DescribePendingMaintenanceActionsMessage.Builder
to
create a request.ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
,
AWS API Documentationdefault DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest)
,
AWS API Documentationdefault DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest
- A Consumer
that will call methods on DescribePendingMaintenanceActionsMessage.Builder
to
create a request.ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeReservedDbInstancesRequest
- ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeReservedDbInstancesRequest.builder()
describeReservedDbInstancesRequest
- A Consumer
that will call methods on DescribeReservedDBInstancesMessage.Builder
to create
a request.ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedDbInstancesResponse describeReservedDBInstances() throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedDBInstances(DescribeReservedDbInstancesRequest)
,
AWS API Documentationdefault DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator() throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest)
,
AWS API Documentationdefault DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeReservedDbInstancesRequest
- ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable responses = client.describeReservedDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeReservedDbInstancesRequest.builder()
describeReservedDbInstancesRequest
- A Consumer
that will call methods on DescribeReservedDBInstancesMessage.Builder
to create
a request.ReservedDbInstanceNotFoundException
- The specified reserved DB Instance not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists available reserved DB instance offerings.
describeReservedDbInstancesOfferingsRequest
- ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
DescribeReservedDbInstancesOfferingsRequest.builder()
describeReservedDbInstancesOfferingsRequest
- A Consumer
that will call methods on DescribeReservedDBInstancesOfferingsMessage.Builder
to create a request.ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings() throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists available reserved DB instance offerings.
ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest)
,
AWS API Documentationdefault DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator() throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists available reserved DB instance offerings.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest)
,
AWS API Documentationdefault DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists available reserved DB instance offerings.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeReservedDbInstancesOfferingsRequest
- ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(Consumer<DescribeReservedDbInstancesOfferingsRequest.Builder> describeReservedDbInstancesOfferingsRequest) throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists available reserved DB instance offerings.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable responses = client.describeReservedDBInstancesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via
DescribeReservedDbInstancesOfferingsRequest.builder()
describeReservedDbInstancesOfferingsRequest
- A Consumer
that will call methods on DescribeReservedDBInstancesOfferingsMessage.Builder
to create a request.ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeSourceRegionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeSourceRegionsRequest.builder()
describeSourceRegionsRequest
- A Consumer
that will call methods on DescribeSourceRegionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSourceRegionsResponse describeSourceRegions() 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeSourceRegions(DescribeSourceRegionsRequest)
,
AWS API
Documentationdefault DescribeSourceRegionsIterable describeSourceRegionsPaginator() 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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeSourceRegionsPaginator(DescribeSourceRegionsRequest)
,
AWS API
Documentationdefault DescribeSourceRegionsIterable describeSourceRegionsPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeSourceRegionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSourceRegionsIterable describeSourceRegionsPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DescribeSourceRegionsIterable responses = client.describeSourceRegionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeSourceRegionsRequest.builder()
describeSourceRegionsRequest
- A Consumer
that will call methods on DescribeSourceRegionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 call ModifyDBInstance
.
This command doesn't apply to RDS Custom.
describeValidDbInstanceModificationsRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 call ModifyDBInstance
.
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 via
DescribeValidDbInstanceModificationsRequest.builder()
describeValidDbInstanceModificationsRequest
- A Consumer
that will call methods on DescribeValidDBInstanceModificationsMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
downloadDbLogFilePortionRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbLogFileNotFoundException
- LogFileName
doesn't refer to an existing DB log file.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DownloadDbLogFilePortionRequest.builder()
downloadDbLogFilePortionRequest
- A Consumer
that will call methods on DownloadDBLogFilePortionMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbLogFileNotFoundException
- LogFileName
doesn't refer to an existing DB log file.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(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.
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 Stream
software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
downloadDbLogFilePortionRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbLogFileNotFoundException
- LogFileName
doesn't refer to an existing DB log file.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(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 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 Stream
software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable responses = client.downloadDBLogFilePortionPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DownloadDbLogFilePortionRequest.builder()
downloadDbLogFilePortionRequest
- A Consumer
that will call methods on DownloadDBLogFilePortionMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbLogFileNotFoundException
- LogFileName
doesn't refer to an existing DB log file.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
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.
failoverDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
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 via FailoverDbClusterRequest.builder()
failoverDbClusterRequest
- A Consumer
that will call methods on FailoverDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default FailoverGlobalClusterResponse failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Initiates the failover process for an Aurora global database (GlobalCluster).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
failoverGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default FailoverGlobalClusterResponse failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Initiates the failover process for an Aurora global database (GlobalCluster).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
This is a convenience which creates an instance of the FailoverGlobalClusterRequest.Builder
avoiding the
need to create one manually via FailoverGlobalClusterRequest.builder()
failoverGlobalClusterRequest
- A Consumer
that will call methods on FailoverGlobalClusterMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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.
listTagsForResourceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
modifyActivityStreamRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.ResourceNotFoundException
- The specified resource ID was not found.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyActivityStreamRequest.builder()
modifyActivityStreamRequest
- A Consumer
that will call methods on ModifyActivityStreamRequest.Builder
to create a
request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.ResourceNotFoundException
- The specified resource ID was not found.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
modifyCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyCertificatesRequest.builder()
modifyCertificatesRequest
- A Consumer
that will call methods on ModifyCertificatesMessage.Builder
to create a
request.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 default TimeoutAction
, 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 action only applies to Aurora Serverless v1 DB clusters.
modifyCurrentDbClusterCapacityRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterCapacityException
- Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
2
, 4
, 8
, 16
, 32
, 64
,
128
, and 256
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 default TimeoutAction
, 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 action 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 via ModifyCurrentDbClusterCapacityRequest.builder()
modifyCurrentDbClusterCapacityRequest
- A Consumer
that will call methods on ModifyCurrentDBClusterCapacityMessage.Builder
to
create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterCapacityException
- Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
2
, 4
, 8
, 16
, 32
, 64
,
128
, and 256
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
ModifyCustomDbEngineVersion
event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
modifyCustomDbEngineVersionRequest
- CustomDbEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDbEngineVersionStateException
- You can't delete the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
ModifyCustomDbEngineVersion
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 via ModifyCustomDbEngineVersionRequest.builder()
modifyCustomDbEngineVersionRequest
- A Consumer
that will call methods on ModifyCustomDBEngineVersionMessage.Builder
to create
a request.CustomDbEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDbEngineVersionStateException
- You can't delete the CEV.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, DbInstanceAlreadyExistsException, DomainNotFoundException, StorageTypeNotAvailableException, 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.
modifyDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.StorageTypeNotAvailableException
- The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use
this storage type less than one month ago.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, DbInstanceAlreadyExistsException, DomainNotFoundException, StorageTypeNotAvailableException, 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 via ModifyDbClusterRequest.builder()
modifyDbClusterRequest
- A Consumer
that will call methods on ModifyDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.StorageTypeNotAvailableException
- The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use
this storage type less than one month ago.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action only applies to Aurora DB clusters.
modifyDbClusterEndpointRequest
- InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action 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 via ModifyDbClusterEndpointRequest.builder()
modifyDbClusterEndpointRequest
- A Consumer
that will call methods on ModifyDBClusterEndpointMessage.Builder
to create a
request.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DbClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and ApplyMethod
. 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 action 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 the DescribeDBClusterParameters
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.
modifyDbClusterParameterGroupRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and ApplyMethod
. 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 action 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 the DescribeDBClusterParameters
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 via ModifyDbClusterParameterGroupRequest.builder()
modifyDbClusterParameterGroupRequest
- A Consumer
that will call methods on ModifyDBClusterParameterGroupMessage.Builder
to
create a request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the AttributeName
and use the ValuesToAdd
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 value
all
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 use all
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.
modifyDbClusterSnapshotAttributeRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the AttributeName
and use the ValuesToAdd
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 value
all
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 use all
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 via ModifyDbClusterSnapshotAttributeRequest.builder()
modifyDbClusterSnapshotAttributeRequest
- A Consumer
that will call methods on ModifyDBClusterSnapshotAttributeMessage.Builder
to
create a request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 call ModifyDBInstance
.
modifyDbInstanceRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on can't be modified.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 call ModifyDBInstance
.
This is a convenience which creates an instance of the ModifyDbInstanceRequest.Builder
avoiding the need
to create one manually via ModifyDbInstanceRequest.builder()
modifyDbInstanceRequest
- A Consumer
that will call methods on ModifyDBInstanceMessage.Builder
to create a request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DbUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on can't be modified.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and ApplyMethod
. 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 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.
modifyDbParameterGroupRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and ApplyMethod
. 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 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 ModifyDbParameterGroupRequest.Builder
avoiding the
need to create one manually via ModifyDbParameterGroupRequest.builder()
modifyDbParameterGroupRequest
- A Consumer
that will call methods on ModifyDBParameterGroupMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbProxyResponse modifyDBProxy(ModifyDbProxyRequest modifyDbProxyRequest) throws DbProxyNotFoundException, DbProxyAlreadyExistsException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Changes the settings for an existing DB proxy.
modifyDbProxyRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyDbProxyRequest.builder()
modifyDbProxyRequest
- A Consumer
that will call methods on ModifyDBProxyRequest.Builder
to create a request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbProxyEndpointResponse modifyDBProxyEndpoint(ModifyDbProxyEndpointRequest modifyDbProxyEndpointRequest) throws DbProxyEndpointNotFoundException, DbProxyEndpointAlreadyExistsException, InvalidDbProxyEndpointStateException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Changes the settings for an existing DB proxy endpoint.
modifyDbProxyEndpointRequest
- DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.DbProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.InvalidDbProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyDbProxyEndpointRequest.builder()
modifyDbProxyEndpointRequest
- A Consumer
that will call methods on ModifyDBProxyEndpointRequest.Builder
to create a
request.DbProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.DbProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.InvalidDbProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbProxyTargetGroupResponse modifyDBProxyTargetGroup(ModifyDbProxyTargetGroupRequest modifyDbProxyTargetGroupRequest) throws DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, InvalidDbProxyStateException, AwsServiceException, SdkClientException, RdsException
Modifies the properties of a DBProxyTargetGroup
.
modifyDbProxyTargetGroupRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyDbProxyTargetGroupRequest.builder()
modifyDbProxyTargetGroupRequest
- A Consumer
that will call methods on ModifyDBProxyTargetGroupRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 command doesn't apply to RDS Custom.
modifyDbSnapshotRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 command doesn't apply to RDS Custom.
This is a convenience which creates an instance of the ModifyDbSnapshotRequest.Builder
avoiding the need
to create one manually via ModifyDbSnapshotRequest.builder()
modifyDbSnapshotRequest
- A Consumer
that will call methods on ModifyDBSnapshotMessage.Builder
to create a request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual DB snapshot. Uses the value all
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 use all
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.
modifyDbSnapshotAttributeRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual DB snapshot. Uses the value all
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 use all
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 via ModifyDbSnapshotAttributeRequest.builder()
modifyDbSnapshotAttributeRequest
- A Consumer
that will call methods on ModifyDBSnapshotAttributeMessage.Builder
to create a
request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
modifyDbSubnetGroupRequest
- DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyDbSubnetGroupRequest.builder()
modifyDbSubnetGroupRequest
- A Consumer
that will call methods on ModifyDBSubnetGroupMessage.Builder
to create a
request.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and
RemoveSourceIdentifierFromSubscription
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 the DescribeEventCategories
operation.
modifyEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SnsInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SnsNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SnsTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and
RemoveSourceIdentifierFromSubscription
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 the DescribeEventCategories
operation.
This is a convenience which creates an instance of the ModifyEventSubscriptionRequest.Builder
avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest
- A Consumer
that will call methods on ModifyEventSubscriptionMessage.Builder
to create a
request.EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SnsInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SnsNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SnsTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException
Modifies a setting for an Amazon Aurora global 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.
modifyGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException
Modifies a setting for an Amazon Aurora global 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 via ModifyGlobalClusterRequest.builder()
modifyGlobalClusterRequest
- A Consumer
that will call methods on ModifyGlobalClusterMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyOptionGroupResponse modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) throws InvalidOptionGroupStateException, OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Modifies an existing option group.
modifyOptionGroupRequest
- InvalidOptionGroupStateException
- The option group isn't in the available state.OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ModifyOptionGroupRequest.builder()
modifyOptionGroupRequest
- A Consumer
that will call methods on ModifyOptionGroupMessage.Builder
to create a request.InvalidOptionGroupStateException
- The option group isn't in the available state.OptionGroupNotFoundException
- The specified option group could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
promoteReadReplicaRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via PromoteReadReplicaRequest.builder()
promoteReadReplicaRequest
- A Consumer
that will call methods on PromoteReadReplicaMessage.Builder
to create a
request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException
Promotes a read replica DB cluster to a standalone DB cluster.
promoteReadReplicaDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via PromoteReadReplicaDbClusterRequest.builder()
promoteReadReplicaDbClusterRequest
- A Consumer
that will call methods on PromoteReadReplicaDBClusterMessage.Builder
to create
a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PurchaseReservedDbInstancesOfferingResponse purchaseReservedDBInstancesOffering(PurchaseReservedDbInstancesOfferingRequest purchaseReservedDbInstancesOfferingRequest) throws ReservedDbInstancesOfferingNotFoundException, ReservedDbInstanceAlreadyExistsException, ReservedDbInstanceQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Purchases a reserved DB instance offering.
purchaseReservedDbInstancesOfferingRequest
- ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.ReservedDbInstanceAlreadyExistsException
- User already has a reservation with the given identifier.ReservedDbInstanceQuotaExceededException
- Request would exceed the user's DB Instance quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via PurchaseReservedDbInstancesOfferingRequest.builder()
purchaseReservedDbInstancesOfferingRequest
- A Consumer
that will call methods on PurchaseReservedDBInstancesOfferingMessage.Builder
to
create a request.ReservedDbInstancesOfferingNotFoundException
- Specified offering does not exist.ReservedDbInstanceAlreadyExistsException
- User already has a reservation with the given identifier.ReservedDbInstanceQuotaExceededException
- Request would exceed the user's DB Instance quota.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
rebootDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RebootDbClusterRequest.builder()
rebootDbClusterRequest
- A Consumer
that will call methods on RebootDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
rebootDbInstanceRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RebootDbInstanceRequest.builder()
rebootDbInstanceRequest
- A Consumer
that will call methods on RebootDBInstanceMessage.Builder
to create a request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 a DBProxyTargetGroup
.
registerDbProxyTargetsRequest
- DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbProxyTargetAlreadyRegisteredException
- The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.InsufficientAvailableIPsInSubnetException
- The requested operation can't be performed because there aren't enough available IP addresses in the
proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the
subnets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 a DBProxyTargetGroup
.
This is a convenience which creates an instance of the RegisterDbProxyTargetsRequest.Builder
avoiding the
need to create one manually via RegisterDbProxyTargetsRequest.builder()
registerDbProxyTargetsRequest
- A Consumer
that will call methods on RegisterDBProxyTargetsRequest.Builder
to create a
request.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbProxyTargetAlreadyRegisteredException
- The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbProxyStateException
- The requested operation can't be performed while the proxy is in this state.InsufficientAvailableIPsInSubnetException
- The requested operation can't be performed because there aren't enough available IP addresses in the
proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the
subnets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action only applies to Aurora DB clusters.
removeFromGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action 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 via RemoveFromGlobalClusterRequest.builder()
removeFromGlobalClusterRequest
- A Consumer
that will call methods on RemoveFromGlobalClusterMessage.Builder
to create a
request.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
removeRoleFromDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterRoleNotFoundException
- The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RemoveRoleFromDbClusterRequest.builder()
removeRoleFromDbClusterRequest
- A Consumer
that will call methods on RemoveRoleFromDBClusterMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterRoleNotFoundException
- The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
removeRoleFromDbInstanceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbInstanceRoleNotFoundException
- The specified RoleArn
value doesn't match the specified feature for the DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RemoveRoleFromDbInstanceRequest.builder()
removeRoleFromDbInstanceRequest
- A Consumer
that will call methods on RemoveRoleFromDBInstanceMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbInstanceRoleNotFoundException
- The specified RoleArn
value doesn't match the specified feature for the DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
RemoveSourceIdentifierFromSubscriptionRequest.builder()
removeSourceIdentifierFromSubscriptionRequest
- A Consumer
that will call methods on RemoveSourceIdentifierFromSubscriptionMessage.Builder
to create a request.SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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.
removeTagsFromResourceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, DbProxyNotFoundException, DbProxyTargetGroupNotFoundException, BlueGreenDeploymentNotFoundException, 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 via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DbProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and ApplyMethod
. To reset the entire DB cluster
parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
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 or RebootDBInstance
request. You must call RebootDBInstance
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.
resetDbClusterParameterGroupRequest
- InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and ApplyMethod
. To reset the entire DB cluster
parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
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 or RebootDBInstance
request. You must call RebootDBInstance
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 via ResetDbClusterParameterGroupRequest.builder()
resetDbClusterParameterGroupRequest
- A Consumer
that will call methods on ResetDBClusterParameterGroupMessage.Builder
to create
a request.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and ApplyMethod
. To reset the entire DB
parameter group, specify the DBParameterGroup
name and ResetAllParameters
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 or RebootDBInstance
request.
resetDbParameterGroupRequest
- InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and ApplyMethod
. To reset the entire DB
parameter group, specify the DBParameterGroup
name and ResetAllParameters
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 or RebootDBInstance
request.
This is a convenience which creates an instance of the ResetDbParameterGroupRequest.Builder
avoiding the
need to create one manually via ResetDbParameterGroupRequest.builder()
resetDbParameterGroupRequest
- A Consumer
that will call methods on ResetDBParameterGroupMessage.Builder
to create a
request.InvalidDbParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromS3
action 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 action only applies to Aurora DB clusters. The source DB engine must be MySQL.
restoreDbClusterFromS3Request
- DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromS3
action 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 action 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 via RestoreDbClusterFromS3Request.builder()
restoreDbClusterFromS3Request
- A Consumer
that will call methods on RestoreDBClusterFromS3Message.Builder
to create a
request.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, InvalidDbInstanceStateException, 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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromSnapshot
action 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.
restoreDbClusterFromSnapshotRequest
- DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InsufficientDbClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, DbClusterParameterGroupNotFoundException, InvalidDbInstanceStateException, 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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromSnapshot
action 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 via RestoreDbClusterFromSnapshotRequest.builder()
restoreDbClusterFromSnapshotRequest
- A Consumer
that will call methods on RestoreDBClusterFromSnapshotMessage.Builder
to create
a request.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InsufficientDbClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 to BackupRetentionPeriod
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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke
the CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterToPointInTime
action 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.
restoreDbClusterToPointInTimeRequest
- DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InsufficientDbClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.OptionGroupNotFoundException
- The specified option group could not be found.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 to BackupRetentionPeriod
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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke
the CreateDBInstance
action to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterToPointInTime
action 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 via RestoreDbClusterToPointInTimeRequest.builder()
restoreDbClusterToPointInTimeRequest
- A Consumer
that will call methods on RestoreDBClusterToPointInTimeMessage.Builder
to
create a request.DbClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InsufficientDbClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.OptionGroupNotFoundException
- The specified option group could not be found.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.DbClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 action. 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 the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. 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
.
restoreDbInstanceFromDbSnapshotRequest
- DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 action. 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 the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. 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 via RestoreDbInstanceFromDbSnapshotRequest.builder()
restoreDbInstanceFromDbSnapshotRequest
- A Consumer
that will call methods on RestoreDBInstanceFromDBSnapshotMessage.Builder
to
create a request.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDbSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbInstanceFromS3Response restoreDBInstanceFromS3(RestoreDbInstanceFromS3Request restoreDbInstanceFromS3Request) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, InvalidS3BucketException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, NetworkTypeNotSupportedException, 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 command doesn't apply to RDS Custom.
restoreDbInstanceFromS3Request
- DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 command 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 via RestoreDbInstanceFromS3Request.builder()
restoreDbInstanceFromS3Request
- A Consumer
that will call methods on RestoreDBInstanceFromS3Message.Builder
to create a
request.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 the BackupRetentionPeriod 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 command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterToPointInTime
.
restoreDbInstanceToPointInTimeRequest
- DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier
refers to a DB instance with BackupRetentionPeriod
equal to 0.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, 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 the BackupRetentionPeriod 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 command 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 via RestoreDbInstanceToPointInTimeRequest.builder()
restoreDbInstanceToPointInTimeRequest
- A Consumer
that will call methods on RestoreDBInstanceToPointInTimeMessage.Builder
to
create a request.DbInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier
refers to a DB instance with BackupRetentionPeriod
equal to 0.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAzException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DbParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DbInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
revokeDbSecurityGroupIngressRequest
- DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RevokeDbSecurityGroupIngressRequest.builder()
revokeDbSecurityGroupIngressRequest
- A Consumer
that will call methods on RevokeDBSecurityGroupIngressMessage.Builder
to create
a request.DbSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
InvalidDbSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
startActivityStreamRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via StartActivityStreamRequest.builder()
startActivityStreamRequest
- A Consumer
that will call methods on StartActivityStreamRequest.Builder
to create a
request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
startDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This action 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 via StartDbClusterRequest.builder()
startDbClusterRequest
- A Consumer
that will call methods on StartDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action.
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.
startDbInstanceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action.
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 via StartDbInstanceRequest.builder()
startDbInstanceRequest
- A Consumer
that will call methods on StartDBInstanceMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InsufficientDbInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DbSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVpcNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
startDbInstanceAutomatedBackupsReplicationRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
StartDbInstanceAutomatedBackupsReplicationRequest.builder()
startDbInstanceAutomatedBackupsReplicationRequest
- A Consumer
that will call methods on
StartDBInstanceAutomatedBackupsReplicationMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DbInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 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.
startExportTaskRequest
- DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.ExportTaskAlreadyExistsException
- You can't start an export task that's already running.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.IamRoleNotFoundException
- The IAM role is missing for exporting to an Amazon S3 bucket.IamRoleMissingPermissionsException
- The IAM role requires additional permissions to export to an Amazon S3 bucket.InvalidExportOnlyException
- The export is invalid for exporting to an Amazon S3 bucket.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidExportSourceStateException
- The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 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 via StartExportTaskRequest.builder()
startExportTaskRequest
- A Consumer
that will call methods on StartExportTaskMessage.Builder
to create a request.DbSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.ExportTaskAlreadyExistsException
- You can't start an export task that's already running.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.IamRoleNotFoundException
- The IAM role is missing for exporting to an Amazon S3 bucket.IamRoleMissingPermissionsException
- The IAM role requires additional permissions to export to an Amazon S3 bucket.InvalidExportOnlyException
- The export is invalid for exporting to an Amazon S3 bucket.KmsKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidExportSourceStateException
- The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the StartActivityStream
action.
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.
stopActivityStreamRequest
- InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the StartActivityStream
action.
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 via StopActivityStreamRequest.builder()
stopActivityStreamRequest
- A Consumer
that will call methods on StopActivityStreamRequest.Builder
to create a
request.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action only applies to Aurora DB clusters.
stopDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 action 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 via StopDbClusterRequest.builder()
stopDbClusterRequest
- A Consumer
that will call methods on StopDBClusterMessage.Builder
to create a request.DbClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
stopDbInstanceRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via StopDbInstanceRequest.builder()
stopDbInstanceRequest
- A Consumer
that will call methods on StopDBInstanceMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.DbSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDbClusterStateException
- The requested operation can't be performed while the cluster is in this state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
stopDbInstanceAutomatedBackupsReplicationRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
StopDbInstanceAutomatedBackupsReplicationRequest.builder()
stopDbInstanceAutomatedBackupsReplicationRequest
- A Consumer
that will call methods on
StopDBInstanceAutomatedBackupsReplicationMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
switchoverBlueGreenDeploymentRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SwitchoverBlueGreenDeploymentRequest.builder()
switchoverBlueGreenDeploymentRequest
- A Consumer
that will call methods on SwitchoverBlueGreenDeploymentRequest.Builder
to
create a request.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
switchoverReadReplicaRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SwitchoverReadReplicaRequest.builder()
switchoverReadReplicaRequest
- A Consumer
that will call methods on SwitchoverReadReplicaMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDbInstanceStateException
- The DB instance isn't in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RdsUtilities utilities()
RdsUtilities
object with the configuration set on this client.default RdsWaiter waiter()
RdsWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
RdsWaiter
static RdsClient create()
RdsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RdsClientBuilder builder()
RdsClient
.static ServiceMetadata serviceMetadata()
default RdsServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration
in interface AwsClient
serviceClientConfiguration
in interface SdkClient
Copyright © 2023. All rights reserved.