@Generated(value="software.amazon.awssdk:codegen") public interface RdsClient extends SdkClient
builder()
method.
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable 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. Note that 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_NAME |
Modifier and Type | Method and Description |
---|---|
default AddRoleToDBClusterResponse |
addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
|
default AddRoleToDBClusterResponse |
addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
|
default AddRoleToDBInstanceResponse |
addRoleToDBInstance(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest)
Associates an AWS Identity and Access Management (IAM) role with a DB instance.
|
default AddRoleToDBInstanceResponse |
addRoleToDBInstance(Consumer<AddRoleToDbInstanceRequest.Builder> addRoleToDbInstanceRequest)
Associates an AWS 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 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 CreateDbClusterResponse |
createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)
Creates a new Amazon Aurora DB cluster.
|
default CreateDbClusterResponse |
createDBCluster(CreateDbClusterRequest createDbClusterRequest)
Creates a new Amazon Aurora 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.
|
default CreateDbInstanceReadReplicaResponse |
createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest)
Creates a new DB instance that acts as a Read Replica for an existing source DB instance.
|
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 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 DBSnapshot.
|
default CreateDbSnapshotResponse |
createDBSnapshot(CreateDbSnapshotRequest createDbSnapshotRequest)
Creates a DBSnapshot.
|
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) |
default CreateGlobalClusterResponse |
createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) |
default CreateOptionGroupResponse |
createOptionGroup(Consumer<CreateOptionGroupRequest.Builder> createOptionGroupRequest)
Creates a new option group.
|
default CreateOptionGroupResponse |
createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
Creates a new option group.
|
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 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 based on the source instance's
DbiResourceId value or the restorable
instance's resource ID. |
default DeleteDbInstanceAutomatedBackupResponse |
deleteDBInstanceAutomatedBackup(DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest)
Deletes automated backups based on the source instance's
DbiResourceId value or the restorable
instance's resource ID. |
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 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 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 DescribeCertificatesResponse |
describeCertificates()
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
|
default DescribeCertificatesResponse |
describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
|
default DescribeCertificatesResponse |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
|
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 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 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 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 DescribeDbClustersResponse |
describeDBClusters()
Returns information about provisioned Aurora DB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Aurora DB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Aurora 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 DescribeDBClustersIterable |
describeDBClustersPaginator()
Returns information about provisioned Aurora DB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Aurora DB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Aurora 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()
Returns information about provisioned RDS instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned RDS instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned RDS instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator()
Returns information about provisioned RDS instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned RDS instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about 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 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 security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups 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 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 engine.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
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 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 AWS Regions where the current AWS Region can create a Read Replica or copy a DB
snapshot from.
|
default DescribeSourceRegionsResponse |
describeSourceRegions(Consumer<DescribeSourceRegionsRequest.Builder> describeSourceRegionsRequest)
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB
snapshot from.
|
default DescribeSourceRegionsResponse |
describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest)
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB
snapshot 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 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 ModifyCurrentDbClusterCapacityResponse |
modifyCurrentDBClusterCapacity(Consumer<ModifyCurrentDbClusterCapacityRequest.Builder> modifyCurrentDbClusterCapacityRequest)
Set the capacity of an Aurora Serverless DB cluster to a specific value.
|
default ModifyCurrentDbClusterCapacityResponse |
modifyCurrentDBClusterCapacity(ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest)
Set the capacity of an Aurora Serverless DB cluster to a specific value.
|
default ModifyDbClusterResponse |
modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)
Modify a setting for an Amazon Aurora DB cluster.
|
default ModifyDbClusterResponse |
modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
Modify a setting for an Amazon Aurora 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 ModifyDbSnapshotResponse |
modifyDBSnapshot(Consumer<ModifyDbSnapshotRequest.Builder> modifyDbSnapshotRequest)
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
|
default ModifyDbSnapshotResponse |
modifyDBSnapshot(ModifyDbSnapshotRequest modifyDbSnapshotRequest)
Updates a manual DB snapshot, which can be encrypted or not encrypted, 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)
Modify a setting for an Amazon Aurora global cluster.
|
default ModifyGlobalClusterResponse |
modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify 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 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 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)
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
|
default RemoveRoleFromDBClusterResponse |
removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest)
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
|
default RemoveRoleFromDBInstanceResponse |
removeRoleFromDBInstance(Consumer<RemoveRoleFromDbInstanceRequest.Builder> removeRoleFromDbInstanceRequest)
Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
|
default RemoveRoleFromDBInstanceResponse |
removeRoleFromDBInstance(RemoveRoleFromDbInstanceRequest removeRoleFromDbInstanceRequest)
Disassociates an AWS 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 data stored in an Amazon S3 bucket.
|
default RestoreDbClusterFromS3Response |
restoreDBClusterFromS3(RestoreDbClusterFromS3Request restoreDbClusterFromS3Request)
Creates an Amazon Aurora DB cluster from 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.
|
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 AWS console, the stop-db-cluster AWS CLI command,
or the StopDBCluster action.
|
default StartDbClusterResponse |
startDBCluster(StartDbClusterRequest startDbClusterRequest)
Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command,
or the StopDBCluster action.
|
default StartDbInstanceResponse |
startDBInstance(Consumer<StartDbInstanceRequest.Builder> startDbInstanceRequest)
Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or
the StopDBInstance action.
|
default StartDbInstanceResponse |
startDBInstance(StartDbInstanceRequest startDbInstanceRequest)
Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or
the StopDBInstance action.
|
default StopActivityStreamResponse |
stopActivityStream(Consumer<StopActivityStreamRequest.Builder> stopActivityStreamRequest)
Stops a database activity stream that was started using the AWS console, the
start-activity-stream
AWS CLI command, or the StartActivityStream action. |
default StopActivityStreamResponse |
stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest)
Stops a database activity stream that was started using the AWS console, the
start-activity-stream
AWS 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.
|
serviceName
close
static final String SERVICE_NAME
static RdsClient create()
RdsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RdsClientBuilder builder()
RdsClient
.default AddRoleToDBClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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 from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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 AWS 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
.
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 AWS 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 AWS 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 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 AWS 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, DbSnapshotNotFoundException, DbClusterNotFoundException, 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.DbSnapshotNotFoundException
- DBSnapshotIdentifier doesn't refer to an existing DB snapshot.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 AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, 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.DbSnapshotNotFoundException
- DBSnapshotIdentifier doesn't refer to an existing DB snapshot.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 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 AWS 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.
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 CIDRIP 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 AWS 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.
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 CIDRIP 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 only applies to Aurora 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 only applies to Aurora 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 CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException
Copies the specified DB cluster parameter group.
This action only applies to Aurora DB clusters.
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 action only applies to Aurora DB clusters.
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 AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination AWS 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 AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier
in the pre-signed 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 DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
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.
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 AWS 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 AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination AWS 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 AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier
in the pre-signed 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 DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
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 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 AWS 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, 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 AWS Region to another. In that case, the AWS Region where you call the
CopyDBSnapshot
action is the destination AWS Region for the DB snapshot copy.
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 AWS 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 CopyDbSnapshotResponse copyDBSnapshot(Consumer<CopyDbSnapshotRequest.Builder> copyDbSnapshotRequest) throws DbSnapshotAlreadyExistsException, DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, 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 AWS Region to another. In that case, the AWS Region where you call the
CopyDBSnapshot
action is the destination AWS Region for the DB snapshot copy.
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 AWS 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 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 AWS 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 AWS 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 CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, RdsException
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of
another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified
by ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
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.
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 AWS 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
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, AwsServiceException, SdkClientException, RdsException
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of
another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified
by ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
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 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 AWS 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
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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 only applies 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 only applies 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 DB cluster, you need to reboot the DB instances in 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
action 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.
This action only applies to Aurora DB clusters.
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 DB cluster, you need to reboot the DB instances in 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
action 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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance.
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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS KMS key.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 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, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance.
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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS KMS key.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 CreateDbInstanceReadReplicaResponse createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest createDbInstanceReadReplicaRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbSubnetGroupNotAllowedException, InvalidDbSubnetGroupException, StorageTypeNotSupportedException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. You must call the CreateDBInstance
action to create a DB
instance for an Aurora DB cluster.
All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.
Your source DB instance 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.InvalidDbInstanceStateException
- The DB instance isn't in a valid 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
- Storage of the StorageType specified can't be associated with the DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 CreateDbInstanceReadReplicaResponse createDBInstanceReadReplica(Consumer<CreateDbInstanceReadReplicaRequest.Builder> createDbInstanceReadReplicaRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbSubnetGroupNotAllowedException, InvalidDbSubnetGroupException, StorageTypeNotSupportedException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. You must call the CreateDBInstance
action to create a DB
instance for an Aurora DB cluster.
All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.
Your source DB instance 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.InvalidDbInstanceStateException
- The DB instance isn't in a valid 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
- Storage of the StorageType specified can't be associated with the DB instance.KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 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.
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.
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 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.
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.
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 DBSnapshot. The source DBInstance must be in "available" 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 DBSnapshot. The source DBInstance must be in "available" 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 AWS 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 AWS 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 action requires a topic ARN (Amazon Resource Name) 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) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
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 SND 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 action requires a topic ARN (Amazon Resource Name) 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) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
This is a convenience which creates an instance of the CreateEventSubscriptionRequest.Builder
avoiding
the need to create one manually 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 SND 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 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 add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action only applies to Aurora DB clusters.
createGlobalClusterRequest
- GlobalClusterAlreadyExistsException
GlobalClusterQuotaExceededException
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 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 add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action only applies 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
GlobalClusterQuotaExceededException
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.
createOptionGroupRequest
- OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this AWS 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 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 AWS 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 DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, 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.
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, 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.
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 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
Note that 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.
Note that 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 based on the source instance's DbiResourceId
value or the restorable
instance's resource ID.
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 based on the source instance's DbiResourceId
value or the restorable
instance's resource ID.
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 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.
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.
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
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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 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 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 DescribeCertificatesResponse describeCertificates() throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
CertificateNotFoundException
- CertificateIdentifier doesn't refer to an existing certificate.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.RdsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeCertificates(DescribeCertificatesRequest)
,
AWS API
Documentationdefault DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
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 AWS account.
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 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 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 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 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 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 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.
This action only applies to Aurora DB clusters.
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 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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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.
This action only applies to Aurora DB clusters.
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 AWS accounts, DescribeDBClusterSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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 action only applies to Aurora DB clusters.
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 AWS accounts, DescribeDBClusterSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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 action only applies to Aurora DB clusters.
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() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about DB cluster snapshots. This API action 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.
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 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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, 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 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() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned Aurora DB 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.
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 DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned Aurora DB 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.
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
Returns information about provisioned Aurora DB 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 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 DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned Aurora DB 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
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(....);
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
Returns information about provisioned Aurora DB 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
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(....);
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
Returns information about provisioned Aurora DB 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
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(....);
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() 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 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 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(....);
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(....);
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(....);
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() 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 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 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(....);
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(....);
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(....);
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() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned RDS instances. This API supports pagination.
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 DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned RDS instances. This API supports pagination.
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
Returns information about provisioned RDS instances. This API supports pagination.
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 DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Returns information about provisioned RDS instances. This API supports pagination.
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(....);
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
Returns information about provisioned RDS instances. This API supports pagination.
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(....);
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
Returns information about provisioned RDS instances. This API supports pagination.
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(....);
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.
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 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 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(....);
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 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(....);
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() 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 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 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(....);
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(....);
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(....);
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(....);
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(....);
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 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.
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 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.
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.
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 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.
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(....);
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.
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(....);
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.
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(....);
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 AWS accounts, DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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 AWS accounts, DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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() 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 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 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(....);
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(....);
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(....);
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() 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 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 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(....);
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(....);
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(....);
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(....);
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(....);
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() throws AwsServiceException, SdkClientException, RdsException
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS 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 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 see a list of the event categories and source types in the Events topic in the Amazon RDS 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 see a list of the event categories and source types in the Events topic in the Amazon RDS 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 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 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 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(....);
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(....);
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(....);
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() throws AwsServiceException, SdkClientException, RdsException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, 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 DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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 security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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 DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RdsException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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(....);
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 security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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(....);
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 security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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(....);
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 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, 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 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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() 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(....);
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.
GlobalClusterNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, 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(....);
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)
operation.
describeGlobalClustersRequest
- GlobalClusterNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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(....);
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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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(....);
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(....);
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() 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 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 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(....);
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(....);
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(....);
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 engine.
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 engine.
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 engine.
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(....);
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 engine.
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(....);
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() 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 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 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 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 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(....);
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(....);
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(....);
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() 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 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 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(....);
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(....);
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(....);
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() throws AwsServiceException, SdkClientException, RdsException
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, 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 DescribeSourceRegionsResponse describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest) throws AwsServiceException, SdkClientException, RdsException
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
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 AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
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
.
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 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.
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 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 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(....);
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 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(....);
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.
A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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.
A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need 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, 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 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 ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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 DB cluster to a specific value.
Aurora Serverless 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 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, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections
that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling
points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
This action only applies to Aurora 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 DB cluster to a specific value.
Aurora Serverless 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 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, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections
that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling
points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
This action only applies to Aurora 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 ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, RdsException
Modify a setting for an Amazon Aurora DB 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 action only applies to Aurora DB clusters.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, AwsServiceException, SdkClientException, RdsException
Modify a setting for an Amazon Aurora DB 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 action only applies to Aurora DB clusters.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can 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 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
action to verify that your DB cluster parameter group
has been created or modified.
This action only applies to Aurora DB clusters.
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.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can 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 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
action to verify that your DB cluster parameter group
has been created or modified.
This action only applies to Aurora DB clusters.
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not
add the all
value for any manual DB cluster snapshots that contain private information that you
don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use
all
as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB
cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes
API action.
This action only applies to Aurora DB clusters.
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not
add the all
value for any manual DB cluster snapshots that contain private information that you
don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use
all
as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB
cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes
API action.
This action only applies to Aurora DB clusters.
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, 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
CertificateNotFoundException
- CertificateIdentifier doesn't refer to an existing certificate.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 ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
CertificateNotFoundException
- CertificateIdentifier doesn't refer to an existing certificate.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 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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
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 ModifyDbSnapshotResponse modifyDBSnapshot(ModifyDbSnapshotRequest modifyDbSnapshotRequest) throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
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, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not add the
all
value for any manual DB snapshots that contain private information that you don't want available
to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of
authorized AWS account IDs for the ValuesToAdd
parameter. You can't use all
as a value
for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot
public or private, use the DescribeDBSnapshotAttributes
API action.
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not add the
all
value for any manual DB snapshots that contain private information that you don't want available
to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of
authorized AWS account IDs for the ValuesToAdd
parameter. You can't use all
as a value
for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot
public or private, use the DescribeDBSnapshotAttributes
API action.
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 AWS 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 AWS 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. Note that 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 SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
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 SND 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. Note that 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 SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
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 SND 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, AwsServiceException, SdkClientException, RdsException
Modify 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 action only applies to Aurora DB clusters.
modifyGlobalClusterRequest
- GlobalClusterNotFoundException
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, AwsServiceException, SdkClientException, RdsException
Modify 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 action only applies to Aurora DB 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
InvalidGlobalClusterStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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 and Aurora PostgreSQL.
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 and Aurora PostgreSQL.
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.
This action only applies to Aurora DB clusters.
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 action only applies to Aurora DB clusters.
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 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.
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 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 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
InvalidGlobalClusterStateException
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
InvalidGlobalClusterStateException
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
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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 AWS 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 specifed 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 AWS 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 specifed 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, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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, 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 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, InsufficientStorageClusterCapacityException, AwsServiceException, SdkClientException, RdsException
Creates an Amazon Aurora DB cluster from 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 to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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 AWS KMS key.DbClusterNotFoundException
- DBClusterIdentifier doesn't refer to an existing DB cluster.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, InsufficientStorageClusterCapacityException, AwsServiceException, SdkClientException, RdsException
Creates an Amazon Aurora DB cluster from 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 to an Amazon Aurora MySQL DB 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 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 AWS KMS key.DbClusterNotFoundException
- DBClusterIdentifier doesn't refer to an existing DB cluster.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
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.
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 AWS KMS key.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName doesn't refer to an existing DB cluster 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 RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
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 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 AWS KMS key.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName doesn't refer to an existing DB cluster 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 RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, 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.
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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
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 AWS 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.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName doesn't refer to an existing DB cluster 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 RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, 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.
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, 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 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 AWS 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.DbClusterParameterGroupNotFoundException
- DBClusterParameterGroupName doesn't refer to an existing DB cluster 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 RestoreDbInstanceFromDbSnapshotResponse restoreDBInstanceFromDBSnapshot(RestoreDbInstanceFromDbSnapshotRequest restoreDbInstanceFromDbSnapshotRequest) throws DbInstanceAlreadyExistsException, DbSnapshotNotFoundException, InstanceQuotaExceededException, InsufficientDbInstanceCapacityException, InvalidDbSnapshotStateException, StorageQuotaExceededException, InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security 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 AZ deployment and not a single-AZ deployment.
If your intent is 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. Once 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 will 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, AwsServiceException, SdkClientException, RdsException
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security 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 AZ deployment and not a single-AZ deployment.
If your intent is 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. Once 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 will 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, 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.
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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 RestoreDbInstanceFromS3Response restoreDBInstanceFromS3(Consumer<RestoreDbInstanceFromS3Request.Builder> restoreDbInstanceFromS3Request) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException, InvalidS3BucketException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, 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 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 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, 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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, 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
- Storage of the StorageType specified can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure 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).
revokeDbSecurityGroupIngressRequest
- DbSecurityGroupNotFoundException
- DBSecurityGroupName doesn't refer to an existing DB security group.AuthorizationNotFoundException
- The specified CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions 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).
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 CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions 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 Database Activity Streams in the Amazon Aurora 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 AWS 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 Database Activity Streams in the Amazon Aurora 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 AWS 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 AWS console, the stop-db-cluster AWS 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 AWS console, the stop-db-cluster AWS 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 AWS console, the stop-db-instance AWS 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 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 CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 AWS console, the stop-db-instance AWS 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 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 CIDRIP or Amazon EC2 security group isn't authorized for the specified DB security
group.
RDS also may not be authorized by using IAM to perform necessary actions on your behalf.
KmsKeyNotAccessibleException
- An error occurred accessing an AWS 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 StopActivityStreamResponse stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest) throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException
Stops a database activity stream that was started using the AWS console, the start-activity-stream
AWS CLI command, or the StartActivityStream
action.
For more information, see Database Activity Streams in the Amazon Aurora 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 AWS console, the start-activity-stream
AWS CLI command, or the StartActivityStream
action.
For more information, see Database Activity Streams in the Amazon Aurora 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 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 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
static ServiceMetadata serviceMetadata()
Copyright © 2019. All rights reserved.