
software.amazon.awssdk.services.rds.RdsClient Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.rds.model.AddRoleToDBClusterResponse;
import software.amazon.awssdk.services.rds.model.AddRoleToDBInstanceResponse;
import software.amazon.awssdk.services.rds.model.AddRoleToDbClusterRequest;
import software.amazon.awssdk.services.rds.model.AddRoleToDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.AddSourceIdentifierToSubscriptionRequest;
import software.amazon.awssdk.services.rds.model.AddSourceIdentifierToSubscriptionResponse;
import software.amazon.awssdk.services.rds.model.AddTagsToResourceRequest;
import software.amazon.awssdk.services.rds.model.AddTagsToResourceResponse;
import software.amazon.awssdk.services.rds.model.ApplyPendingMaintenanceActionRequest;
import software.amazon.awssdk.services.rds.model.ApplyPendingMaintenanceActionResponse;
import software.amazon.awssdk.services.rds.model.AuthorizationAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.AuthorizationNotFoundException;
import software.amazon.awssdk.services.rds.model.AuthorizationQuotaExceededException;
import software.amazon.awssdk.services.rds.model.AuthorizeDbSecurityGroupIngressRequest;
import software.amazon.awssdk.services.rds.model.AuthorizeDbSecurityGroupIngressResponse;
import software.amazon.awssdk.services.rds.model.BacktrackDbClusterRequest;
import software.amazon.awssdk.services.rds.model.BacktrackDbClusterResponse;
import software.amazon.awssdk.services.rds.model.CertificateNotFoundException;
import software.amazon.awssdk.services.rds.model.CopyDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.CopyDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.CopyDbClusterSnapshotRequest;
import software.amazon.awssdk.services.rds.model.CopyDbClusterSnapshotResponse;
import software.amazon.awssdk.services.rds.model.CopyDbParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.CopyDbParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.CopyDbSnapshotRequest;
import software.amazon.awssdk.services.rds.model.CopyDbSnapshotResponse;
import software.amazon.awssdk.services.rds.model.CopyOptionGroupRequest;
import software.amazon.awssdk.services.rds.model.CopyOptionGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateDbClusterEndpointRequest;
import software.amazon.awssdk.services.rds.model.CreateDbClusterEndpointResponse;
import software.amazon.awssdk.services.rds.model.CreateDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.CreateDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateDbClusterRequest;
import software.amazon.awssdk.services.rds.model.CreateDbClusterResponse;
import software.amazon.awssdk.services.rds.model.CreateDbClusterSnapshotRequest;
import software.amazon.awssdk.services.rds.model.CreateDbClusterSnapshotResponse;
import software.amazon.awssdk.services.rds.model.CreateDbInstanceReadReplicaRequest;
import software.amazon.awssdk.services.rds.model.CreateDbInstanceReadReplicaResponse;
import software.amazon.awssdk.services.rds.model.CreateDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.CreateDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.CreateDbParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.CreateDbParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateDbSecurityGroupRequest;
import software.amazon.awssdk.services.rds.model.CreateDbSecurityGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateDbSnapshotRequest;
import software.amazon.awssdk.services.rds.model.CreateDbSnapshotResponse;
import software.amazon.awssdk.services.rds.model.CreateDbSubnetGroupRequest;
import software.amazon.awssdk.services.rds.model.CreateDbSubnetGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateEventSubscriptionRequest;
import software.amazon.awssdk.services.rds.model.CreateEventSubscriptionResponse;
import software.amazon.awssdk.services.rds.model.CreateGlobalClusterRequest;
import software.amazon.awssdk.services.rds.model.CreateGlobalClusterResponse;
import software.amazon.awssdk.services.rds.model.CreateOptionGroupRequest;
import software.amazon.awssdk.services.rds.model.CreateOptionGroupResponse;
import software.amazon.awssdk.services.rds.model.DbClusterAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbClusterBacktrackNotFoundException;
import software.amazon.awssdk.services.rds.model.DbClusterEndpointAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbClusterEndpointNotFoundException;
import software.amazon.awssdk.services.rds.model.DbClusterEndpointQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbClusterNotFoundException;
import software.amazon.awssdk.services.rds.model.DbClusterParameterGroupNotFoundException;
import software.amazon.awssdk.services.rds.model.DbClusterQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbClusterRoleAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbClusterRoleNotFoundException;
import software.amazon.awssdk.services.rds.model.DbClusterRoleQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbClusterSnapshotAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbClusterSnapshotNotFoundException;
import software.amazon.awssdk.services.rds.model.DbInstanceAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbInstanceAutomatedBackupNotFoundException;
import software.amazon.awssdk.services.rds.model.DbInstanceAutomatedBackupQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbInstanceNotFoundException;
import software.amazon.awssdk.services.rds.model.DbInstanceRoleAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbInstanceRoleNotFoundException;
import software.amazon.awssdk.services.rds.model.DbInstanceRoleQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbLogFileNotFoundException;
import software.amazon.awssdk.services.rds.model.DbParameterGroupAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbParameterGroupNotFoundException;
import software.amazon.awssdk.services.rds.model.DbParameterGroupQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbSecurityGroupAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbSecurityGroupNotFoundException;
import software.amazon.awssdk.services.rds.model.DbSecurityGroupNotSupportedException;
import software.amazon.awssdk.services.rds.model.DbSecurityGroupQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbSnapshotAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbSnapshotNotFoundException;
import software.amazon.awssdk.services.rds.model.DbSubnetGroupAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbSubnetGroupDoesNotCoverEnoughAZsException;
import software.amazon.awssdk.services.rds.model.DbSubnetGroupNotAllowedException;
import software.amazon.awssdk.services.rds.model.DbSubnetGroupNotFoundException;
import software.amazon.awssdk.services.rds.model.DbSubnetGroupQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbSubnetQuotaExceededException;
import software.amazon.awssdk.services.rds.model.DbUpgradeDependencyFailureException;
import software.amazon.awssdk.services.rds.model.DeleteDBClusterParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.DeleteDBParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.DeleteDBSecurityGroupResponse;
import software.amazon.awssdk.services.rds.model.DeleteDBSubnetGroupResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterEndpointRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterEndpointResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterSnapshotRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbClusterSnapshotResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbInstanceAutomatedBackupRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbInstanceAutomatedBackupResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbSecurityGroupRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbSnapshotRequest;
import software.amazon.awssdk.services.rds.model.DeleteDbSnapshotResponse;
import software.amazon.awssdk.services.rds.model.DeleteDbSubnetGroupRequest;
import software.amazon.awssdk.services.rds.model.DeleteEventSubscriptionRequest;
import software.amazon.awssdk.services.rds.model.DeleteEventSubscriptionResponse;
import software.amazon.awssdk.services.rds.model.DeleteGlobalClusterRequest;
import software.amazon.awssdk.services.rds.model.DeleteGlobalClusterResponse;
import software.amazon.awssdk.services.rds.model.DeleteOptionGroupRequest;
import software.amazon.awssdk.services.rds.model.DeleteOptionGroupResponse;
import software.amazon.awssdk.services.rds.model.DescribeAccountAttributesRequest;
import software.amazon.awssdk.services.rds.model.DescribeAccountAttributesResponse;
import software.amazon.awssdk.services.rds.model.DescribeCertificatesRequest;
import software.amazon.awssdk.services.rds.model.DescribeCertificatesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterBacktracksResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterParameterGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterParametersResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotAttributesRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotAttributesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClusterSnapshotsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbClustersResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbLogFilesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbParametersResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbSnapshotAttributesRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbSnapshotAttributesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeEngineDefaultClusterParametersRequest;
import software.amazon.awssdk.services.rds.model.DescribeEngineDefaultClusterParametersResponse;
import software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest;
import software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersResponse;
import software.amazon.awssdk.services.rds.model.DescribeEventCategoriesRequest;
import software.amazon.awssdk.services.rds.model.DescribeEventCategoriesResponse;
import software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest;
import software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsResponse;
import software.amazon.awssdk.services.rds.model.DescribeEventsRequest;
import software.amazon.awssdk.services.rds.model.DescribeEventsResponse;
import software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest;
import software.amazon.awssdk.services.rds.model.DescribeGlobalClustersResponse;
import software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest;
import software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsResponse;
import software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest;
import software.amazon.awssdk.services.rds.model.DescribeOptionGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest;
import software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsResponse;
import software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsRequest;
import software.amazon.awssdk.services.rds.model.DescribePendingMaintenanceActionsResponse;
import software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest;
import software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsResponse;
import software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest;
import software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesResponse;
import software.amazon.awssdk.services.rds.model.DescribeSourceRegionsRequest;
import software.amazon.awssdk.services.rds.model.DescribeSourceRegionsResponse;
import software.amazon.awssdk.services.rds.model.DescribeValidDbInstanceModificationsRequest;
import software.amazon.awssdk.services.rds.model.DescribeValidDbInstanceModificationsResponse;
import software.amazon.awssdk.services.rds.model.DomainNotFoundException;
import software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest;
import software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse;
import software.amazon.awssdk.services.rds.model.EventSubscriptionQuotaExceededException;
import software.amazon.awssdk.services.rds.model.FailoverDbClusterRequest;
import software.amazon.awssdk.services.rds.model.FailoverDbClusterResponse;
import software.amazon.awssdk.services.rds.model.GlobalClusterAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.GlobalClusterNotFoundException;
import software.amazon.awssdk.services.rds.model.GlobalClusterQuotaExceededException;
import software.amazon.awssdk.services.rds.model.InstanceQuotaExceededException;
import software.amazon.awssdk.services.rds.model.InsufficientDbClusterCapacityException;
import software.amazon.awssdk.services.rds.model.InsufficientDbInstanceCapacityException;
import software.amazon.awssdk.services.rds.model.InsufficientStorageClusterCapacityException;
import software.amazon.awssdk.services.rds.model.InvalidDbClusterCapacityException;
import software.amazon.awssdk.services.rds.model.InvalidDbClusterEndpointStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbClusterSnapshotStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbClusterStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbInstanceAutomatedBackupStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbInstanceStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbParameterGroupStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbSecurityGroupStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbSnapshotStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbSubnetGroupException;
import software.amazon.awssdk.services.rds.model.InvalidDbSubnetGroupStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbSubnetStateException;
import software.amazon.awssdk.services.rds.model.InvalidEventSubscriptionStateException;
import software.amazon.awssdk.services.rds.model.InvalidGlobalClusterStateException;
import software.amazon.awssdk.services.rds.model.InvalidOptionGroupStateException;
import software.amazon.awssdk.services.rds.model.InvalidRestoreException;
import software.amazon.awssdk.services.rds.model.InvalidS3BucketException;
import software.amazon.awssdk.services.rds.model.InvalidSubnetException;
import software.amazon.awssdk.services.rds.model.InvalidVpcNetworkStateException;
import software.amazon.awssdk.services.rds.model.KmsKeyNotAccessibleException;
import software.amazon.awssdk.services.rds.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.rds.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.rds.model.ModifyCurrentDbClusterCapacityRequest;
import software.amazon.awssdk.services.rds.model.ModifyCurrentDbClusterCapacityResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterEndpointRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterEndpointResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterSnapshotAttributeRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterSnapshotAttributeResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbSnapshotAttributeRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbSnapshotAttributeResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbSnapshotRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbSnapshotResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbSubnetGroupRequest;
import software.amazon.awssdk.services.rds.model.ModifyDbSubnetGroupResponse;
import software.amazon.awssdk.services.rds.model.ModifyEventSubscriptionRequest;
import software.amazon.awssdk.services.rds.model.ModifyEventSubscriptionResponse;
import software.amazon.awssdk.services.rds.model.ModifyGlobalClusterRequest;
import software.amazon.awssdk.services.rds.model.ModifyGlobalClusterResponse;
import software.amazon.awssdk.services.rds.model.ModifyOptionGroupRequest;
import software.amazon.awssdk.services.rds.model.ModifyOptionGroupResponse;
import software.amazon.awssdk.services.rds.model.OptionGroupAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.OptionGroupNotFoundException;
import software.amazon.awssdk.services.rds.model.OptionGroupQuotaExceededException;
import software.amazon.awssdk.services.rds.model.PointInTimeRestoreNotEnabledException;
import software.amazon.awssdk.services.rds.model.PromoteReadReplicaDbClusterRequest;
import software.amazon.awssdk.services.rds.model.PromoteReadReplicaDbClusterResponse;
import software.amazon.awssdk.services.rds.model.PromoteReadReplicaRequest;
import software.amazon.awssdk.services.rds.model.PromoteReadReplicaResponse;
import software.amazon.awssdk.services.rds.model.ProvisionedIopsNotAvailableInAzException;
import software.amazon.awssdk.services.rds.model.PurchaseReservedDbInstancesOfferingRequest;
import software.amazon.awssdk.services.rds.model.PurchaseReservedDbInstancesOfferingResponse;
import software.amazon.awssdk.services.rds.model.RdsException;
import software.amazon.awssdk.services.rds.model.RebootDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.RebootDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.RemoveFromGlobalClusterRequest;
import software.amazon.awssdk.services.rds.model.RemoveFromGlobalClusterResponse;
import software.amazon.awssdk.services.rds.model.RemoveRoleFromDBClusterResponse;
import software.amazon.awssdk.services.rds.model.RemoveRoleFromDBInstanceResponse;
import software.amazon.awssdk.services.rds.model.RemoveRoleFromDbClusterRequest;
import software.amazon.awssdk.services.rds.model.RemoveRoleFromDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.RemoveSourceIdentifierFromSubscriptionRequest;
import software.amazon.awssdk.services.rds.model.RemoveSourceIdentifierFromSubscriptionResponse;
import software.amazon.awssdk.services.rds.model.RemoveTagsFromResourceRequest;
import software.amazon.awssdk.services.rds.model.RemoveTagsFromResourceResponse;
import software.amazon.awssdk.services.rds.model.ReservedDbInstanceAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.ReservedDbInstanceNotFoundException;
import software.amazon.awssdk.services.rds.model.ReservedDbInstanceQuotaExceededException;
import software.amazon.awssdk.services.rds.model.ReservedDbInstancesOfferingNotFoundException;
import software.amazon.awssdk.services.rds.model.ResetDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.ResetDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.ResetDbParameterGroupRequest;
import software.amazon.awssdk.services.rds.model.ResetDbParameterGroupResponse;
import software.amazon.awssdk.services.rds.model.ResourceNotFoundException;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterFromS3Request;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterFromS3Response;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterFromSnapshotRequest;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterFromSnapshotResponse;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterToPointInTimeRequest;
import software.amazon.awssdk.services.rds.model.RestoreDbClusterToPointInTimeResponse;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromDbSnapshotRequest;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromDbSnapshotResponse;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromS3Request;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromS3Response;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceToPointInTimeRequest;
import software.amazon.awssdk.services.rds.model.RestoreDbInstanceToPointInTimeResponse;
import software.amazon.awssdk.services.rds.model.RevokeDbSecurityGroupIngressRequest;
import software.amazon.awssdk.services.rds.model.RevokeDbSecurityGroupIngressResponse;
import software.amazon.awssdk.services.rds.model.SharedSnapshotQuotaExceededException;
import software.amazon.awssdk.services.rds.model.SnapshotQuotaExceededException;
import software.amazon.awssdk.services.rds.model.SnsInvalidTopicException;
import software.amazon.awssdk.services.rds.model.SnsNoAuthorizationException;
import software.amazon.awssdk.services.rds.model.SnsTopicArnNotFoundException;
import software.amazon.awssdk.services.rds.model.SourceNotFoundException;
import software.amazon.awssdk.services.rds.model.StartActivityStreamRequest;
import software.amazon.awssdk.services.rds.model.StartActivityStreamResponse;
import software.amazon.awssdk.services.rds.model.StartDbClusterRequest;
import software.amazon.awssdk.services.rds.model.StartDbClusterResponse;
import software.amazon.awssdk.services.rds.model.StartDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.StartDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.StopActivityStreamRequest;
import software.amazon.awssdk.services.rds.model.StopActivityStreamResponse;
import software.amazon.awssdk.services.rds.model.StopDbClusterRequest;
import software.amazon.awssdk.services.rds.model.StopDbClusterResponse;
import software.amazon.awssdk.services.rds.model.StopDbInstanceRequest;
import software.amazon.awssdk.services.rds.model.StopDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.StorageQuotaExceededException;
import software.amazon.awssdk.services.rds.model.StorageTypeNotSupportedException;
import software.amazon.awssdk.services.rds.model.SubnetAlreadyInUseException;
import software.amazon.awssdk.services.rds.model.SubscriptionAlreadyExistException;
import software.amazon.awssdk.services.rds.model.SubscriptionCategoryNotFoundException;
import software.amazon.awssdk.services.rds.model.SubscriptionNotFoundException;
import software.amazon.awssdk.services.rds.paginators.DescribeDBClustersIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBEngineVersionsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBInstanceAutomatedBackupsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBLogFilesIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBParameterGroupsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBParametersIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBSecurityGroupsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBSnapshotsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeDBSubnetGroupsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeEngineDefaultParametersIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeEventSubscriptionsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeEventsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeGlobalClustersIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupOptionsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeOptionGroupsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeOrderableDBInstanceOptionsIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesIterable;
import software.amazon.awssdk.services.rds.paginators.DescribeReservedDBInstancesOfferingsIterable;
import software.amazon.awssdk.services.rds.paginators.DownloadDBLogFilePortionIterable;
/**
* Service client for accessing Amazon RDS. This can be created using the static {@link #builder()} method.
*
* Amazon Relational Database Service
*
*
*
* 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.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface RdsClient extends SdkClient {
String SERVICE_NAME = "rds";
/**
* Create a {@link RdsClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static RdsClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link RdsClient}.
*/
static RdsClientBuilder builder() {
return new DefaultRdsClientBuilder();
}
/**
*
* 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.
*
*
*
* @param addRoleToDbClusterRequest
* @return Result of the AddRoleToDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterRoleAlreadyExistsException
* The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterRoleQuotaExceededException
* You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddRoleToDBCluster
* @see AWS API
* Documentation
*/
default AddRoleToDBClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest)
throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException,
DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AddRoleToDbClusterRequest.Builder} avoiding the
* need to create one manually via {@link AddRoleToDbClusterRequest#builder()}
*
*
* @param addRoleToDbClusterRequest
* A {@link Consumer} that will call methods on {@link AddRoleToDBClusterMessage.Builder} to create a
* request.
* @return Result of the AddRoleToDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterRoleAlreadyExistsException
* The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterRoleQuotaExceededException
* You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddRoleToDBCluster
* @see AWS API
* Documentation
*/
default AddRoleToDBClusterResponse addRoleToDBCluster(Consumer addRoleToDbClusterRequest)
throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException,
DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
return addRoleToDBCluster(AddRoleToDbClusterRequest.builder().applyMutation(addRoleToDbClusterRequest).build());
}
/**
*
* 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
.
*
*
*
* @param addRoleToDbInstanceRequest
* @return Result of the AddRoleToDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbInstanceRoleAlreadyExistsException
* The specified RoleArn or FeatureName value is already associated with the DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceRoleQuotaExceededException
* You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because
* the quota has been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddRoleToDBInstance
* @see AWS API
* Documentation
*/
default AddRoleToDBInstanceResponse addRoleToDBInstance(AddRoleToDbInstanceRequest addRoleToDbInstanceRequest)
throws DbInstanceNotFoundException, DbInstanceRoleAlreadyExistsException, InvalidDbInstanceStateException,
DbInstanceRoleQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AddRoleToDbInstanceRequest.Builder} avoiding the
* need to create one manually via {@link AddRoleToDbInstanceRequest#builder()}
*
*
* @param addRoleToDbInstanceRequest
* A {@link Consumer} that will call methods on {@link AddRoleToDBInstanceMessage.Builder} to create a
* request.
* @return Result of the AddRoleToDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbInstanceRoleAlreadyExistsException
* The specified RoleArn or FeatureName value is already associated with the DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceRoleQuotaExceededException
* You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because
* the quota has been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddRoleToDBInstance
* @see AWS API
* Documentation
*/
default AddRoleToDBInstanceResponse addRoleToDBInstance(
Consumer addRoleToDbInstanceRequest) throws DbInstanceNotFoundException,
DbInstanceRoleAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceRoleQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
return addRoleToDBInstance(AddRoleToDbInstanceRequest.builder().applyMutation(addRoleToDbInstanceRequest).build());
}
/**
*
* Adds a source identifier to an existing RDS event notification subscription.
*
*
* @param addSourceIdentifierToSubscriptionRequest
* @return Result of the AddSourceIdentifierToSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddSourceIdentifierToSubscription
* @see AWS API Documentation
*/
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(
AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a source identifier to an existing RDS event notification subscription.
*
*
*
* This is a convenience which creates an instance of the {@link AddSourceIdentifierToSubscriptionRequest.Builder}
* avoiding the need to create one manually via {@link AddSourceIdentifierToSubscriptionRequest#builder()}
*
*
* @param addSourceIdentifierToSubscriptionRequest
* A {@link Consumer} that will call methods on {@link AddSourceIdentifierToSubscriptionMessage.Builder} to
* create a request.
* @return Result of the AddSourceIdentifierToSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddSourceIdentifierToSubscription
* @see AWS API Documentation
*/
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(
Consumer addSourceIdentifierToSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest.builder()
.applyMutation(addSourceIdentifierToSubscriptionRequest).build());
}
/**
*
* 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.
*
*
* @param addTagsToResourceRequest
* @return Result of the AddTagsToResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddTagsToResource
* @see AWS API
* Documentation
*/
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AddTagsToResourceRequest.Builder} avoiding the need
* to create one manually via {@link AddTagsToResourceRequest#builder()}
*
*
* @param addTagsToResourceRequest
* A {@link Consumer} that will call methods on {@link AddTagsToResourceMessage.Builder} to create a request.
* @return Result of the AddTagsToResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AddTagsToResource
* @see AWS API
* Documentation
*/
default AddTagsToResourceResponse addTagsToResource(Consumer addTagsToResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return addTagsToResource(AddTagsToResourceRequest.builder().applyMutation(addTagsToResourceRequest).build());
}
/**
*
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*
*
* @param applyPendingMaintenanceActionRequest
* @return Result of the ApplyPendingMaintenanceAction operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ApplyPendingMaintenanceAction
* @see AWS API Documentation
*/
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(
ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*
*
*
* This is a convenience which creates an instance of the {@link ApplyPendingMaintenanceActionRequest.Builder}
* avoiding the need to create one manually via {@link ApplyPendingMaintenanceActionRequest#builder()}
*
*
* @param applyPendingMaintenanceActionRequest
* A {@link Consumer} that will call methods on {@link ApplyPendingMaintenanceActionMessage.Builder} to
* create a request.
* @return Result of the ApplyPendingMaintenanceAction operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ApplyPendingMaintenanceAction
* @see AWS API Documentation
*/
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(
Consumer applyPendingMaintenanceActionRequest)
throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
return applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest.builder()
.applyMutation(applyPendingMaintenanceActionRequest).build());
}
/**
*
* 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.
*
*
* @param authorizeDbSecurityGroupIngressRequest
* @return Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws AuthorizationAlreadyExistsException
* The specified CIDRIP or Amazon EC2 security group is already authorized for the specified DB security
* group.
* @throws AuthorizationQuotaExceededException
* The DB security group authorization quota has been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AuthorizeDBSecurityGroupIngress
* @see AWS API Documentation
*/
default AuthorizeDbSecurityGroupIngressResponse authorizeDBSecurityGroupIngress(
AuthorizeDbSecurityGroupIngressRequest authorizeDbSecurityGroupIngressRequest)
throws DbSecurityGroupNotFoundException, InvalidDbSecurityGroupStateException, AuthorizationAlreadyExistsException,
AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AuthorizeDbSecurityGroupIngressRequest.Builder}
* avoiding the need to create one manually via {@link AuthorizeDbSecurityGroupIngressRequest#builder()}
*
*
* @param authorizeDbSecurityGroupIngressRequest
* A {@link Consumer} that will call methods on {@link AuthorizeDBSecurityGroupIngressMessage.Builder} to
* create a request.
* @return Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws AuthorizationAlreadyExistsException
* The specified CIDRIP or Amazon EC2 security group is already authorized for the specified DB security
* group.
* @throws AuthorizationQuotaExceededException
* The DB security group authorization quota has been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.AuthorizeDBSecurityGroupIngress
* @see AWS API Documentation
*/
default AuthorizeDbSecurityGroupIngressResponse authorizeDBSecurityGroupIngress(
Consumer authorizeDbSecurityGroupIngressRequest)
throws DbSecurityGroupNotFoundException, InvalidDbSecurityGroupStateException, AuthorizationAlreadyExistsException,
AuthorizationQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
return authorizeDBSecurityGroupIngress(AuthorizeDbSecurityGroupIngressRequest.builder()
.applyMutation(authorizeDbSecurityGroupIngressRequest).build());
}
/**
*
* 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.
*
*
*
* @param backtrackDbClusterRequest
* @return Result of the BacktrackDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.BacktrackDBCluster
* @see AWS API
* Documentation
*/
default BacktrackDbClusterResponse backtrackDBCluster(BacktrackDbClusterRequest backtrackDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BacktrackDbClusterRequest.Builder} avoiding the
* need to create one manually via {@link BacktrackDbClusterRequest#builder()}
*
*
* @param backtrackDbClusterRequest
* A {@link Consumer} that will call methods on {@link BacktrackDBClusterMessage.Builder} to create a
* request.
* @return Result of the BacktrackDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.BacktrackDBCluster
* @see AWS API
* Documentation
*/
default BacktrackDbClusterResponse backtrackDBCluster(Consumer backtrackDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException,
RdsException {
return backtrackDBCluster(BacktrackDbClusterRequest.builder().applyMutation(backtrackDbClusterRequest).build());
}
/**
*
* Copies the specified DB cluster parameter group.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param copyDbClusterParameterGroupRequest
* @return Result of the CopyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBClusterParameterGroup
* @see AWS API Documentation
*/
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(
CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException,
DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CopyDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link CopyDbClusterParameterGroupRequest#builder()}
*
*
* @param copyDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CopyDBClusterParameterGroupMessage.Builder} to create
* a request.
* @return Result of the CopyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBClusterParameterGroup
* @see AWS API Documentation
*/
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(
Consumer copyDbClusterParameterGroupRequest)
throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException,
DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, RdsException {
return copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest.builder()
.applyMutation(copyDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param copyDbClusterSnapshotRequest
* @return Result of the CopyDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBClusterSnapshot
* @see AWS API
* Documentation
*/
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException,
InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CopyDbClusterSnapshotRequest.Builder} avoiding the
* need to create one manually via {@link CopyDbClusterSnapshotRequest#builder()}
*
*
* @param copyDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link CopyDBClusterSnapshotMessage.Builder} to create a
* request.
* @return Result of the CopyDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBClusterSnapshot
* @see AWS API
* Documentation
*/
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(
Consumer copyDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException,
InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException,
AwsServiceException, SdkClientException, RdsException {
return copyDBClusterSnapshot(CopyDbClusterSnapshotRequest.builder().applyMutation(copyDbClusterSnapshotRequest).build());
}
/**
*
* Copies the specified DB parameter group.
*
*
* @param copyDbParameterGroupRequest
* @return Result of the CopyDBParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBParameterGroup
* @see AWS API
* Documentation
*/
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest)
throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException,
DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Copies the specified DB parameter group.
*
*
*
* This is a convenience which creates an instance of the {@link CopyDbParameterGroupRequest.Builder} avoiding the
* need to create one manually via {@link CopyDbParameterGroupRequest#builder()}
*
*
* @param copyDbParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CopyDBParameterGroupMessage.Builder} to create a
* request.
* @return Result of the CopyDBParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBParameterGroup
* @see AWS API
* Documentation
*/
default CopyDbParameterGroupResponse copyDBParameterGroup(
Consumer copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException,
DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException,
SdkClientException, RdsException {
return copyDBParameterGroup(CopyDbParameterGroupRequest.builder().applyMutation(copyDbParameterGroupRequest).build());
}
/**
*
* 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.
*
*
* @param copyDbSnapshotRequest
* @return Result of the CopyDBSnapshot operation returned by the service.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBSnapshot
* @see AWS API
* Documentation
*/
default CopyDbSnapshotResponse copyDBSnapshot(CopyDbSnapshotRequest copyDbSnapshotRequest)
throws DbSnapshotAlreadyExistsException, DbSnapshotNotFoundException, InvalidDbSnapshotStateException,
SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CopyDbSnapshotRequest.Builder} avoiding the need to
* create one manually via {@link CopyDbSnapshotRequest#builder()}
*
*
* @param copyDbSnapshotRequest
* A {@link Consumer} that will call methods on {@link CopyDBSnapshotMessage.Builder} to create a request.
* @return Result of the CopyDBSnapshot operation returned by the service.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyDBSnapshot
* @see AWS API
* Documentation
*/
default CopyDbSnapshotResponse copyDBSnapshot(Consumer copyDbSnapshotRequest)
throws DbSnapshotAlreadyExistsException, DbSnapshotNotFoundException, InvalidDbSnapshotStateException,
SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
return copyDBSnapshot(CopyDbSnapshotRequest.builder().applyMutation(copyDbSnapshotRequest).build());
}
/**
*
* Copies the specified option group.
*
*
* @param copyOptionGroupRequest
* @return Result of the CopyOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyOptionGroup
* @see AWS API
* Documentation
*/
default CopyOptionGroupResponse copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)
throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Copies the specified option group.
*
*
*
* This is a convenience which creates an instance of the {@link CopyOptionGroupRequest.Builder} avoiding the need
* to create one manually via {@link CopyOptionGroupRequest#builder()}
*
*
* @param copyOptionGroupRequest
* A {@link Consumer} that will call methods on {@link CopyOptionGroupMessage.Builder} to create a request.
* @return Result of the CopyOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CopyOptionGroup
* @see AWS API
* Documentation
*/
default CopyOptionGroupResponse copyOptionGroup(Consumer copyOptionGroupRequest)
throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
return copyOptionGroup(CopyOptionGroupRequest.builder().applyMutation(copyOptionGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param createDbClusterRequest
* @return Result of the CreateDBCluster operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws 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.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBCluster
* @see AWS API
* Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link CreateDbClusterRequest#builder()}
*
*
* @param createDbClusterRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterMessage.Builder} to create a request.
* @return Result of the CreateDBCluster operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws 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.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBCluster
* @see AWS API
* Documentation
*/
default CreateDbClusterResponse createDBCluster(Consumer createDbClusterRequest)
throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException,
StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException,
InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException,
InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException,
DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException,
GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
RdsException {
return createDBCluster(CreateDbClusterRequest.builder().applyMutation(createDbClusterRequest).build());
}
/**
*
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createDbClusterEndpointRequest
* @return Result of the CreateDBClusterEndpoint operation returned by the service.
* @throws DbClusterEndpointQuotaExceededException
* The cluster already has the maximum number of custom endpoints.
* @throws DbClusterEndpointAlreadyExistsException
* The specified custom endpoint can't be created because it already exists.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterEndpoint
* @see AWS
* API Documentation
*/
default CreateDbClusterEndpointResponse createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest)
throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException,
InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbClusterEndpointRequest.Builder} avoiding
* the need to create one manually via {@link CreateDbClusterEndpointRequest#builder()}
*
*
* @param createDbClusterEndpointRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterEndpointMessage.Builder} to create a
* request.
* @return Result of the CreateDBClusterEndpoint operation returned by the service.
* @throws DbClusterEndpointQuotaExceededException
* The cluster already has the maximum number of custom endpoints.
* @throws DbClusterEndpointAlreadyExistsException
* The specified custom endpoint can't be created because it already exists.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterEndpoint
* @see AWS
* API Documentation
*/
default CreateDbClusterEndpointResponse createDBClusterEndpoint(
Consumer createDbClusterEndpointRequest)
throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException,
InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException,
SdkClientException, RdsException {
return createDBClusterEndpoint(CreateDbClusterEndpointRequest.builder().applyMutation(createDbClusterEndpointRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param createDbClusterParameterGroupRequest
* @return Result of the CreateDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterParameterGroup
* @see AWS API Documentation
*/
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(
CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link CreateDbClusterParameterGroupRequest#builder()}
*
*
* @param createDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterParameterGroupMessage.Builder} to
* create a request.
* @return Result of the CreateDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterParameterGroup
* @see AWS API Documentation
*/
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(
Consumer createDbClusterParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, RdsException {
return createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest.builder()
.applyMutation(createDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param createDbClusterSnapshotRequest
* @return Result of the CreateDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbClusterSnapshotRequest.Builder} avoiding
* the need to create one manually via {@link CreateDbClusterSnapshotRequest#builder()}
*
*
* @param createDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterSnapshotMessage.Builder} to create a
* request.
* @return Result of the CreateDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(
Consumer createDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
RdsException {
return createDBClusterSnapshot(CreateDbClusterSnapshotRequest.builder().applyMutation(createDbClusterSnapshotRequest)
.build());
}
/**
*
* Creates a new DB instance.
*
*
* @param createDbInstanceRequest
* @return Result of the CreateDBInstance operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBInstance
* @see AWS API
* Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new DB instance.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link CreateDbInstanceRequest#builder()}
*
*
* @param createDbInstanceRequest
* A {@link Consumer} that will call methods on {@link CreateDBInstanceMessage.Builder} to create a request.
* @return Result of the CreateDBInstance operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBInstance
* @see AWS API
* Documentation
*/
default CreateDbInstanceResponse createDBInstance(Consumer createDbInstanceRequest)
throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException,
DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException,
InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException,
OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException,
AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return createDBInstance(CreateDbInstanceRequest.builder().applyMutation(createDbInstanceRequest).build());
}
/**
*
* 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.
*
*
*
* @param createDbInstanceReadReplicaRequest
* @return Result of the CreateDBInstanceReadReplica operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbSubnetGroupNotAllowedException
* The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
* source instance.
* @throws InvalidDbSubnetGroupException
* The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
* same source instance.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBInstanceReadReplica
* @see AWS API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbInstanceReadReplicaRequest.Builder}
* avoiding the need to create one manually via {@link CreateDbInstanceReadReplicaRequest#builder()}
*
*
* @param createDbInstanceReadReplicaRequest
* A {@link Consumer} that will call methods on {@link CreateDBInstanceReadReplicaMessage.Builder} to create
* a request.
* @return Result of the CreateDBInstanceReadReplica operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbSubnetGroupNotAllowedException
* The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
* source instance.
* @throws InvalidDbSubnetGroupException
* The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
* same source instance.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBInstanceReadReplica
* @see AWS API Documentation
*/
default CreateDbInstanceReadReplicaResponse createDBInstanceReadReplica(
Consumer createDbInstanceReadReplicaRequest)
throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException,
DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException,
DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSubnetGroupNotFoundException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVpcNetworkStateException,
ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbSubnetGroupNotAllowedException,
InvalidDbSubnetGroupException, StorageTypeNotSupportedException, KmsKeyNotAccessibleException, AwsServiceException,
SdkClientException, RdsException {
return createDBInstanceReadReplica(CreateDbInstanceReadReplicaRequest.builder()
.applyMutation(createDbInstanceReadReplicaRequest).build());
}
/**
*
* 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.
*
*
*
* @param createDbParameterGroupRequest
* @return Result of the CreateDBParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBParameterGroup
* @see AWS API
* Documentation
*/
default CreateDbParameterGroupResponse createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbParameterGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDbParameterGroupRequest#builder()}
*
*
* @param createDbParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBParameterGroupMessage.Builder} to create a
* request.
* @return Result of the CreateDBParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBParameterGroup
* @see AWS API
* Documentation
*/
default CreateDbParameterGroupResponse createDBParameterGroup(
Consumer createDbParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, RdsException {
return createDBParameterGroup(CreateDbParameterGroupRequest.builder().applyMutation(createDbParameterGroupRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param createDbSecurityGroupRequest
* @return Result of the CreateDBSecurityGroup operation returned by the service.
* @throws DbSecurityGroupAlreadyExistsException
* A DB security group with the name specified in DBSecurityGroupName already exists.
* @throws DbSecurityGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB security groups.
* @throws DbSecurityGroupNotSupportedException
* A DB security group isn't allowed for this action.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSecurityGroup
* @see AWS API
* Documentation
*/
default CreateDbSecurityGroupResponse createDBSecurityGroup(CreateDbSecurityGroupRequest createDbSecurityGroupRequest)
throws DbSecurityGroupAlreadyExistsException, DbSecurityGroupQuotaExceededException,
DbSecurityGroupNotSupportedException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbSecurityGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDbSecurityGroupRequest#builder()}
*
*
* @param createDbSecurityGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBSecurityGroupMessage.Builder} to create a
* request.
* @return Result of the CreateDBSecurityGroup operation returned by the service.
* @throws DbSecurityGroupAlreadyExistsException
* A DB security group with the name specified in DBSecurityGroupName already exists.
* @throws DbSecurityGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB security groups.
* @throws DbSecurityGroupNotSupportedException
* A DB security group isn't allowed for this action.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSecurityGroup
* @see AWS API
* Documentation
*/
default CreateDbSecurityGroupResponse createDBSecurityGroup(
Consumer createDbSecurityGroupRequest)
throws DbSecurityGroupAlreadyExistsException, DbSecurityGroupQuotaExceededException,
DbSecurityGroupNotSupportedException, AwsServiceException, SdkClientException, RdsException {
return createDBSecurityGroup(CreateDbSecurityGroupRequest.builder().applyMutation(createDbSecurityGroupRequest).build());
}
/**
*
* Creates a DBSnapshot. The source DBInstance must be in "available" state.
*
*
* @param createDbSnapshotRequest
* @return Result of the CreateDBSnapshot operation returned by the service.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSnapshot
* @see AWS API
* Documentation
*/
default CreateDbSnapshotResponse createDBSnapshot(CreateDbSnapshotRequest createDbSnapshotRequest)
throws DbSnapshotAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceNotFoundException,
SnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a DBSnapshot. The source DBInstance must be in "available" state.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDbSnapshotRequest.Builder} avoiding the need
* to create one manually via {@link CreateDbSnapshotRequest#builder()}
*
*
* @param createDbSnapshotRequest
* A {@link Consumer} that will call methods on {@link CreateDBSnapshotMessage.Builder} to create a request.
* @return Result of the CreateDBSnapshot operation returned by the service.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSnapshot
* @see AWS API
* Documentation
*/
default CreateDbSnapshotResponse createDBSnapshot(Consumer createDbSnapshotRequest)
throws DbSnapshotAlreadyExistsException, InvalidDbInstanceStateException, DbInstanceNotFoundException,
SnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
return createDBSnapshot(CreateDbSnapshotRequest.builder().applyMutation(createDbSnapshotRequest).build());
}
/**
*
* Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS
* Region.
*
*
* @param createDbSubnetGroupRequest
* @return Result of the CreateDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupAlreadyExistsException
* DBSubnetGroupName is already used by an existing DB subnet group.
* @throws DbSubnetGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB subnet groups.
* @throws DbSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSubnetGroup
* @see AWS API
* Documentation
*/
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDbSubnetGroupRequest#builder()}
*
*
* @param createDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBSubnetGroupMessage.Builder} to create a
* request.
* @return Result of the CreateDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupAlreadyExistsException
* DBSubnetGroupName is already used by an existing DB subnet group.
* @throws DbSubnetGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB subnet groups.
* @throws DbSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateDBSubnetGroup
* @see AWS API
* Documentation
*/
default CreateDbSubnetGroupResponse createDBSubnetGroup(
Consumer createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException,
DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException,
InvalidSubnetException, AwsServiceException, SdkClientException, RdsException {
return createDBSubnetGroup(CreateDbSubnetGroupRequest.builder().applyMutation(createDbSubnetGroupRequest).build());
}
/**
*
* 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.
*
*
* @param createEventSubscriptionRequest
* @return Result of the CreateEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionAlreadyExistException
* The supplied subscription name already exists.
* @throws SnsInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SnsTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateEventSubscription
* @see AWS
* API Documentation
*/
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link CreateEventSubscriptionRequest#builder()}
*
*
* @param createEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link CreateEventSubscriptionMessage.Builder} to create a
* request.
* @return Result of the CreateEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionAlreadyExistException
* The supplied subscription name already exists.
* @throws SnsInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SnsTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateEventSubscription
* @see AWS
* API Documentation
*/
default CreateEventSubscriptionResponse createEventSubscription(
Consumer createEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return createEventSubscription(CreateEventSubscriptionRequest.builder().applyMutation(createEventSubscriptionRequest)
.build());
}
/**
*
*
*
* 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.
*
*
*
* @param createGlobalClusterRequest
* @return Result of the CreateGlobalCluster operation returned by the service.
* @throws GlobalClusterAlreadyExistsException
* @throws GlobalClusterQuotaExceededException
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateGlobalCluster
* @see AWS API
* Documentation
*/
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException,
DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
*
*
* 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 {@link CreateGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link CreateGlobalClusterRequest#builder()}
*
*
* @param createGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link CreateGlobalClusterMessage.Builder} to create a
* request.
* @return Result of the CreateGlobalCluster operation returned by the service.
* @throws GlobalClusterAlreadyExistsException
* @throws GlobalClusterQuotaExceededException
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateGlobalCluster
* @see AWS API
* Documentation
*/
default CreateGlobalClusterResponse createGlobalCluster(
Consumer createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException,
GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return createGlobalCluster(CreateGlobalClusterRequest.builder().applyMutation(createGlobalClusterRequest).build());
}
/**
*
* Creates a new option group. You can create up to 20 option groups.
*
*
* @param createOptionGroupRequest
* @return Result of the CreateOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateOptionGroup
* @see AWS API
* Documentation
*/
default CreateOptionGroupResponse createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
throws OptionGroupAlreadyExistsException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new option group. You can create up to 20 option groups.
*
*
*
* This is a convenience which creates an instance of the {@link CreateOptionGroupRequest.Builder} avoiding the need
* to create one manually via {@link CreateOptionGroupRequest#builder()}
*
*
* @param createOptionGroupRequest
* A {@link Consumer} that will call methods on {@link CreateOptionGroupMessage.Builder} to create a request.
* @return Result of the CreateOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.CreateOptionGroup
* @see AWS API
* Documentation
*/
default CreateOptionGroupResponse createOptionGroup(Consumer createOptionGroupRequest)
throws OptionGroupAlreadyExistsException, OptionGroupQuotaExceededException, AwsServiceException, SdkClientException,
RdsException {
return createOptionGroup(CreateOptionGroupRequest.builder().applyMutation(createOptionGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDbClusterRequest
* @return Result of the DeleteDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBCluster
* @see AWS API
* Documentation
*/
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDbClusterRequest#builder()}
*
*
* @param deleteDbClusterRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterMessage.Builder} to create a request.
* @return Result of the DeleteDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBCluster
* @see AWS API
* Documentation
*/
default DeleteDbClusterResponse deleteDBCluster(Consumer deleteDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
RdsException {
return deleteDBCluster(DeleteDbClusterRequest.builder().applyMutation(deleteDbClusterRequest).build());
}
/**
*
* Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteDbClusterEndpointRequest
* @return Result of the DeleteDBClusterEndpoint operation returned by the service.
* @throws InvalidDbClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DbClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterEndpoint
* @see AWS
* API Documentation
*/
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest)
throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterEndpointRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDbClusterEndpointRequest#builder()}
*
*
* @param deleteDbClusterEndpointRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterEndpointMessage.Builder} to create a
* request.
* @return Result of the DeleteDBClusterEndpoint operation returned by the service.
* @throws InvalidDbClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DbClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterEndpoint
* @see AWS
* API Documentation
*/
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(
Consumer deleteDbClusterEndpointRequest)
throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException,
AwsServiceException, SdkClientException, RdsException {
return deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest.builder().applyMutation(deleteDbClusterEndpointRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param deleteDbClusterParameterGroupRequest
* @return Result of the DeleteDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterParameterGroup
* @see AWS API Documentation
*/
default DeleteDBClusterParameterGroupResponse deleteDBClusterParameterGroup(
DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link DeleteDbClusterParameterGroupRequest#builder()}
*
*
* @param deleteDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterParameterGroupMessage.Builder} to
* create a request.
* @return Result of the DeleteDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterParameterGroup
* @see AWS API Documentation
*/
default DeleteDBClusterParameterGroupResponse deleteDBClusterParameterGroup(
Consumer deleteDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest.builder()
.applyMutation(deleteDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDbClusterSnapshotRequest
* @return Result of the DeleteDBClusterSnapshot operation returned by the service.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterSnapshot
* @see AWS
* API Documentation
*/
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterSnapshotRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDbClusterSnapshotRequest#builder()}
*
*
* @param deleteDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterSnapshotMessage.Builder} to create a
* request.
* @return Result of the DeleteDBClusterSnapshot operation returned by the service.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBClusterSnapshot
* @see AWS
* API Documentation
*/
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(
Consumer deleteDbClusterSnapshotRequest)
throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest.builder().applyMutation(deleteDbClusterSnapshotRequest)
.build());
}
/**
*
* 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.
*
*
* @param deleteDbInstanceRequest
* @return Result of the DeleteDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBInstance
* @see AWS API
* Documentation
*/
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDbInstanceRequest#builder()}
*
*
* @param deleteDbInstanceRequest
* A {@link Consumer} that will call methods on {@link DeleteDBInstanceMessage.Builder} to create a request.
* @return Result of the DeleteDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBInstance
* @see AWS API
* Documentation
*/
default DeleteDbInstanceResponse deleteDBInstance(Consumer deleteDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, DbInstanceAutomatedBackupQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
return deleteDBInstance(DeleteDbInstanceRequest.builder().applyMutation(deleteDbInstanceRequest).build());
}
/**
*
* Deletes automated backups based on the source instance's DbiResourceId
value or the restorable
* instance's resource ID.
*
*
* @param deleteDbInstanceAutomatedBackupRequest
* Parameter input for the DeleteDBInstanceAutomatedBackup
operation.
* @return Result of the DeleteDBInstanceAutomatedBackup operation returned by the service.
* @throws InvalidDbInstanceAutomatedBackupStateException
* The automated backup is in an invalid state. For example, this automated backup is associated with an
* active instance.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBInstanceAutomatedBackup
* @see AWS API Documentation
*/
default DeleteDbInstanceAutomatedBackupResponse deleteDBInstanceAutomatedBackup(
DeleteDbInstanceAutomatedBackupRequest deleteDbInstanceAutomatedBackupRequest)
throws InvalidDbInstanceAutomatedBackupStateException, DbInstanceAutomatedBackupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbInstanceAutomatedBackupRequest.Builder}
* avoiding the need to create one manually via {@link DeleteDbInstanceAutomatedBackupRequest#builder()}
*
*
* @param deleteDbInstanceAutomatedBackupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBInstanceAutomatedBackupMessage.Builder} to
* create a request. Parameter input for the DeleteDBInstanceAutomatedBackup
operation.
* @return Result of the DeleteDBInstanceAutomatedBackup operation returned by the service.
* @throws InvalidDbInstanceAutomatedBackupStateException
* The automated backup is in an invalid state. For example, this automated backup is associated with an
* active instance.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBInstanceAutomatedBackup
* @see AWS API Documentation
*/
default DeleteDbInstanceAutomatedBackupResponse deleteDBInstanceAutomatedBackup(
Consumer deleteDbInstanceAutomatedBackupRequest)
throws InvalidDbInstanceAutomatedBackupStateException, DbInstanceAutomatedBackupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return deleteDBInstanceAutomatedBackup(DeleteDbInstanceAutomatedBackupRequest.builder()
.applyMutation(deleteDbInstanceAutomatedBackupRequest).build());
}
/**
*
* Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB
* instances.
*
*
* @param deleteDbParameterGroupRequest
* @return Result of the DeleteDBParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBParameterGroup
* @see AWS API
* Documentation
*/
default DeleteDBParameterGroupResponse deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbParameterGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDbParameterGroupRequest#builder()}
*
*
* @param deleteDbParameterGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBParameterGroupMessage.Builder} to create a
* request.
* @return Result of the DeleteDBParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBParameterGroup
* @see AWS API
* Documentation
*/
default DeleteDBParameterGroupResponse deleteDBParameterGroup(
Consumer deleteDbParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return deleteDBParameterGroup(DeleteDbParameterGroupRequest.builder().applyMutation(deleteDbParameterGroupRequest)
.build());
}
/**
*
* Deletes a DB security group.
*
*
*
* The specified DB security group must not be associated with any DB instances.
*
*
*
* @param deleteDbSecurityGroupRequest
* @return Result of the DeleteDBSecurityGroup operation returned by the service.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSecurityGroup
* @see AWS API
* Documentation
*/
default DeleteDBSecurityGroupResponse deleteDBSecurityGroup(DeleteDbSecurityGroupRequest deleteDbSecurityGroupRequest)
throws InvalidDbSecurityGroupStateException, DbSecurityGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbSecurityGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDbSecurityGroupRequest#builder()}
*
*
* @param deleteDbSecurityGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBSecurityGroupMessage.Builder} to create a
* request.
* @return Result of the DeleteDBSecurityGroup operation returned by the service.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSecurityGroup
* @see AWS API
* Documentation
*/
default DeleteDBSecurityGroupResponse deleteDBSecurityGroup(
Consumer deleteDbSecurityGroupRequest)
throws InvalidDbSecurityGroupStateException, DbSecurityGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return deleteDBSecurityGroup(DeleteDbSecurityGroupRequest.builder().applyMutation(deleteDbSecurityGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDbSnapshotRequest
* @return Result of the DeleteDBSnapshot operation returned by the service.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSnapshot
* @see AWS API
* Documentation
*/
default DeleteDbSnapshotResponse deleteDBSnapshot(DeleteDbSnapshotRequest deleteDbSnapshotRequest)
throws InvalidDbSnapshotStateException, DbSnapshotNotFoundException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbSnapshotRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDbSnapshotRequest#builder()}
*
*
* @param deleteDbSnapshotRequest
* A {@link Consumer} that will call methods on {@link DeleteDBSnapshotMessage.Builder} to create a request.
* @return Result of the DeleteDBSnapshot operation returned by the service.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSnapshot
* @see AWS API
* Documentation
*/
default DeleteDbSnapshotResponse deleteDBSnapshot(Consumer deleteDbSnapshotRequest)
throws InvalidDbSnapshotStateException, DbSnapshotNotFoundException, AwsServiceException, SdkClientException,
RdsException {
return deleteDBSnapshot(DeleteDbSnapshotRequest.builder().applyMutation(deleteDbSnapshotRequest).build());
}
/**
*
* Deletes a DB subnet group.
*
*
*
* The specified database subnet group must not be associated with any DB instances.
*
*
*
* @param deleteDbSubnetGroupRequest
* @return Result of the DeleteDBSubnetGroup operation returned by the service.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidDbSubnetStateException
* The DB subnet isn't in the available state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSubnetGroup
* @see AWS API
* Documentation
*/
default DeleteDBSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDbSubnetGroupRequest#builder()}
*
*
* @param deleteDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBSubnetGroupMessage.Builder} to create a
* request.
* @return Result of the DeleteDBSubnetGroup operation returned by the service.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidDbSubnetStateException
* The DB subnet isn't in the available state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteDBSubnetGroup
* @see AWS API
* Documentation
*/
default DeleteDBSubnetGroupResponse deleteDBSubnetGroup(
Consumer deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException,
InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return deleteDBSubnetGroup(DeleteDbSubnetGroupRequest.builder().applyMutation(deleteDbSubnetGroupRequest).build());
}
/**
*
* Deletes an RDS event notification subscription.
*
*
* @param deleteEventSubscriptionRequest
* @return Result of the DeleteEventSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws InvalidEventSubscriptionStateException
* This error can occur if someone else is modifying a subscription. You should retry the action.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteEventSubscription
* @see AWS
* API Documentation
*/
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an RDS event notification subscription.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteEventSubscriptionRequest#builder()}
*
*
* @param deleteEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link DeleteEventSubscriptionMessage.Builder} to create a
* request.
* @return Result of the DeleteEventSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws InvalidEventSubscriptionStateException
* This error can occur if someone else is modifying a subscription. You should retry the action.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteEventSubscription
* @see AWS
* API Documentation
*/
default DeleteEventSubscriptionResponse deleteEventSubscription(
Consumer deleteEventSubscriptionRequest)
throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException,
SdkClientException, RdsException {
return deleteEventSubscription(DeleteEventSubscriptionRequest.builder().applyMutation(deleteEventSubscriptionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param deleteGlobalClusterRequest
* @return Result of the DeleteGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link DeleteGlobalClusterRequest#builder()}
*
*
* @param deleteGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link DeleteGlobalClusterMessage.Builder} to create a
* request.
* @return Result of the DeleteGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
default DeleteGlobalClusterResponse deleteGlobalCluster(
Consumer deleteGlobalClusterRequest) throws GlobalClusterNotFoundException,
InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, RdsException {
return deleteGlobalCluster(DeleteGlobalClusterRequest.builder().applyMutation(deleteGlobalClusterRequest).build());
}
/**
*
* Deletes an existing option group.
*
*
* @param deleteOptionGroupRequest
* @return Result of the DeleteOptionGroup operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteOptionGroup
* @see AWS API
* Documentation
*/
default DeleteOptionGroupResponse deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
throws OptionGroupNotFoundException, InvalidOptionGroupStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing option group.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteOptionGroupRequest.Builder} avoiding the need
* to create one manually via {@link DeleteOptionGroupRequest#builder()}
*
*
* @param deleteOptionGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteOptionGroupMessage.Builder} to create a request.
* @return Result of the DeleteOptionGroup operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DeleteOptionGroup
* @see AWS API
* Documentation
*/
default DeleteOptionGroupResponse deleteOptionGroup(Consumer deleteOptionGroupRequest)
throws OptionGroupNotFoundException, InvalidOptionGroupStateException, AwsServiceException, SdkClientException,
RdsException {
return deleteOptionGroup(DeleteOptionGroupRequest.builder().applyMutation(deleteOptionGroupRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeAccountAttributes operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeAccountAttributes
* @see #describeAccountAttributes(DescribeAccountAttributesRequest)
* @see AWS
* API Documentation
*/
default DescribeAccountAttributesResponse describeAccountAttributes() throws AwsServiceException, SdkClientException,
RdsException {
return describeAccountAttributes(DescribeAccountAttributesRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeAccountAttributesRequest
* @return Result of the DescribeAccountAttributes operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeAccountAttributes
* @see AWS
* API Documentation
*/
default DescribeAccountAttributesResponse describeAccountAttributes(
DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeAccountAttributesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAccountAttributesRequest#builder()}
*
*
* @param describeAccountAttributesRequest
* A {@link Consumer} that will call methods on {@link DescribeAccountAttributesMessage.Builder} to create a
* request.
* @return Result of the DescribeAccountAttributes operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeAccountAttributes
* @see AWS
* API Documentation
*/
default DescribeAccountAttributesResponse describeAccountAttributes(
Consumer describeAccountAttributesRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeAccountAttributes(DescribeAccountAttributesRequest.builder()
.applyMutation(describeAccountAttributesRequest).build());
}
/**
*
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*
*
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeCertificates
* @see #describeCertificates(DescribeCertificatesRequest)
* @see AWS API
* Documentation
*/
default DescribeCertificatesResponse describeCertificates() throws CertificateNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeCertificates(DescribeCertificatesRequest.builder().build());
}
/**
*
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*
*
* @param describeCertificatesRequest
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeCertificates
* @see AWS API
* Documentation
*/
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
throws CertificateNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCertificatesRequest#builder()}
*
*
* @param describeCertificatesRequest
* A {@link Consumer} that will call methods on {@link DescribeCertificatesMessage.Builder} to create a
* request.
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeCertificates
* @see AWS API
* Documentation
*/
default DescribeCertificatesResponse describeCertificates(
Consumer describeCertificatesRequest) throws CertificateNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeCertificates(DescribeCertificatesRequest.builder().applyMutation(describeCertificatesRequest).build());
}
/**
*
* 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.
*
*
*
* @param describeDbClusterBacktracksRequest
* @return Result of the DescribeDBClusterBacktracks operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterBacktrackNotFoundException
* BacktrackIdentifier doesn't refer to an existing backtrack.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterBacktracks
* @see AWS API Documentation
*/
default DescribeDbClusterBacktracksResponse describeDBClusterBacktracks(
DescribeDbClusterBacktracksRequest describeDbClusterBacktracksRequest) throws DbClusterNotFoundException,
DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterBacktracksRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterBacktracksRequest#builder()}
*
*
* @param describeDbClusterBacktracksRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterBacktracksMessage.Builder} to create
* a request.
* @return Result of the DescribeDBClusterBacktracks operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterBacktrackNotFoundException
* BacktrackIdentifier doesn't refer to an existing backtrack.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterBacktracks
* @see AWS API Documentation
*/
default DescribeDbClusterBacktracksResponse describeDBClusterBacktracks(
Consumer describeDbClusterBacktracksRequest)
throws DbClusterNotFoundException, DbClusterBacktrackNotFoundException, AwsServiceException, SdkClientException,
RdsException {
return describeDBClusterBacktracks(DescribeDbClusterBacktracksRequest.builder()
.applyMutation(describeDbClusterBacktracksRequest).build());
}
/**
*
* Returns information about endpoints for an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @return Result of the DescribeDBClusterEndpoints operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterEndpoints
* @see #describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints() throws DbClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest.builder().build());
}
/**
*
* Returns information about endpoints for an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDbClusterEndpointsRequest
* @return Result of the DescribeDBClusterEndpoints operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterEndpoints
* @see AWS
* API Documentation
*/
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(
DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterEndpointsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbClusterEndpointsRequest#builder()}
*
*
* @param describeDbClusterEndpointsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterEndpointsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBClusterEndpoints operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterEndpoints
* @see AWS
* API Documentation
*/
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(
Consumer describeDbClusterEndpointsRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest.builder()
.applyMutation(describeDbClusterEndpointsRequest).build());
}
/**
*
* 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.
*
*
*
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterParameterGroups
* @see #describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest)
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* @param describeDbClusterParameterGroupsRequest
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(
DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterParameterGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParameterGroupsRequest#builder()}
*
*
* @param describeDbClusterParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParameterGroupsMessage.Builder} to
* create a request.
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(
Consumer describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest.builder()
.applyMutation(describeDbClusterParameterGroupsRequest).build());
}
/**
*
* 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.
*
*
*
* @param describeDbClusterParametersRequest
* @return Result of the DescribeDBClusterParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDbClusterParametersResponse describeDBClusterParameters(
DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParametersRequest#builder()}
*
*
* @param describeDbClusterParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParametersMessage.Builder} to create
* a request.
* @return Result of the DescribeDBClusterParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDbClusterParametersResponse describeDBClusterParameters(
Consumer describeDbClusterParametersRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusterParameters(DescribeDbClusterParametersRequest.builder()
.applyMutation(describeDbClusterParametersRequest).build());
}
/**
*
* 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.
*
*
*
* @param describeDbClusterSnapshotAttributesRequest
* @return Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(
DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterSnapshotAttributesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterSnapshotAttributesRequest#builder()}
*
*
* @param describeDbClusterSnapshotAttributesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterSnapshotAttributesMessage.Builder} to
* create a request.
* @return Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(
Consumer describeDbClusterSnapshotAttributesRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest.builder()
.applyMutation(describeDbClusterSnapshotAttributesRequest).build());
}
/**
*
* 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.
*
*
*
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterSnapshots
* @see #describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* @param describeDbClusterSnapshotsRequest
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterSnapshots
* @see AWS
* API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(
DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterSnapshotsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbClusterSnapshotsRequest#builder()}
*
*
* @param describeDbClusterSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterSnapshotsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusterSnapshots
* @see AWS
* API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(
Consumer describeDbClusterSnapshotsRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest.builder()
.applyMutation(describeDbClusterSnapshotsRequest).build());
}
/**
*
* 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.
*
*
*
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see #describeDBClusters(DescribeDbClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBClusters(DescribeDbClustersRequest.builder().build());
}
/**
*
* 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.
*
*
*
* @param describeDbClustersRequest
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbClustersRequest#builder()}
*
*
* @param describeDbClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClustersMessage.Builder} to create a
* request.
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters(Consumer describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBClusters(DescribeDbClustersRequest.builder().applyMutation(describeDbClustersRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see #describeDBClustersPaginator(DescribeDbClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBClustersPaginator(DescribeDbClustersRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)} operation.
*
*
* @param describeDbClustersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.rds.model.DescribeDbClustersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbClustersRequest#builder()}
*
*
* @param describeDbClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClustersMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator(
Consumer describeDbClustersRequest) throws DbClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBClustersPaginator(DescribeDbClustersRequest.builder().applyMutation(describeDbClustersRequest).build());
}
/**
*
* Returns a list of the available DB engines.
*
*
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see #describeDBEngineVersions(DescribeDbEngineVersionsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException,
RdsException {
return describeDBEngineVersions(DescribeDbEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available DB engines.
*
*
* @param describeDbEngineVersionsRequest
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see AWS
* API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions(
DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available DB engines.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbEngineVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbEngineVersionsRequest#builder()}
*
*
* @param describeDbEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBEngineVersionsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see AWS
* API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions(
Consumer describeDbEngineVersionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeDBEngineVersions(DescribeDbEngineVersionsRequest.builder().applyMutation(describeDbEngineVersionsRequest)
.build());
}
/**
*
* Returns a list of the available DB engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see #describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest)
* @see AWS
* API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException,
RdsException {
return describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available DB engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* @param describeDbEngineVersionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see AWS
* API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(
DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available DB engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.rds.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbEngineVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbEngineVersionsRequest#builder()}
*
*
* @param describeDbEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBEngineVersionsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBEngineVersions
* @see AWS
* API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(
Consumer describeDbEngineVersionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest.builder()
.applyMutation(describeDbEngineVersionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see #describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest)
* @see AWS API Documentation
*/
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups()
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeDbInstanceAutomatedBackupsRequest
* Parameter input for DescribeDBInstanceAutomatedBackups.
* @return Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see AWS API Documentation
*/
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups(
DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest)
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbInstanceAutomatedBackupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbInstanceAutomatedBackupsRequest#builder()}
*
*
* @param describeDbInstanceAutomatedBackupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstanceAutomatedBackupsMessage.Builder} to
* create a request. Parameter input for DescribeDBInstanceAutomatedBackups.
* @return Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see AWS API Documentation
*/
default DescribeDbInstanceAutomatedBackupsResponse describeDBInstanceAutomatedBackups(
Consumer describeDbInstanceAutomatedBackupsRequest)
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBInstanceAutomatedBackups(DescribeDbInstanceAutomatedBackupsRequest.builder()
.applyMutation(describeDbInstanceAutomatedBackupsRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see #describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest)
* @see AWS API Documentation
*/
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator()
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)}
* operation.
*
*
* @param describeDbInstanceAutomatedBackupsRequest
* Parameter input for DescribeDBInstanceAutomatedBackups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see AWS API Documentation
*/
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(
DescribeDbInstanceAutomatedBackupsRequest describeDbInstanceAutomatedBackupsRequest)
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstanceAutomatedBackups(software.amazon.awssdk.services.rds.model.DescribeDbInstanceAutomatedBackupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbInstanceAutomatedBackupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbInstanceAutomatedBackupsRequest#builder()}
*
*
* @param describeDbInstanceAutomatedBackupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstanceAutomatedBackupsMessage.Builder} to
* create a request. Parameter input for DescribeDBInstanceAutomatedBackups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstanceAutomatedBackups
* @see AWS API Documentation
*/
default DescribeDBInstanceAutomatedBackupsIterable describeDBInstanceAutomatedBackupsPaginator(
Consumer describeDbInstanceAutomatedBackupsRequest)
throws DbInstanceAutomatedBackupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBInstanceAutomatedBackupsPaginator(DescribeDbInstanceAutomatedBackupsRequest.builder()
.applyMutation(describeDbInstanceAutomatedBackupsRequest).build());
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see #describeDBInstances(DescribeDbInstancesRequest)
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBInstances(DescribeDbInstancesRequest.builder().build());
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
* @param describeDbInstancesRequest
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbInstancesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbInstancesRequest#builder()}
*
*
* @param describeDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstancesMessage.Builder} to create a
* request.
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances(
Consumer describeDbInstancesRequest) throws DbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBInstances(DescribeDbInstancesRequest.builder().applyMutation(describeDbInstancesRequest).build());
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see #describeDBInstancesPaginator(DescribeDbInstancesRequest)
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBInstancesPaginator(DescribeDbInstancesRequest.builder().build());
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)} operation.
*
*
* @param describeDbInstancesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbInstancesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbInstancesRequest#builder()}
*
*
* @param describeDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstancesMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator(
Consumer describeDbInstancesRequest) throws DbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBInstancesPaginator(DescribeDbInstancesRequest.builder().applyMutation(describeDbInstancesRequest)
.build());
}
/**
*
* Returns a list of DB log files for the DB instance.
*
*
* @param describeDbLogFilesRequest
* @return Result of the DescribeDBLogFiles operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBLogFiles
* @see AWS API
* Documentation
*/
default DescribeDbLogFilesResponse describeDBLogFiles(DescribeDbLogFilesRequest describeDbLogFilesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of DB log files for the DB instance.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbLogFilesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbLogFilesRequest#builder()}
*
*
* @param describeDbLogFilesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBLogFilesMessage.Builder} to create a
* request.
* @return Result of the DescribeDBLogFiles operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBLogFiles
* @see AWS API
* Documentation
*/
default DescribeDbLogFilesResponse describeDBLogFiles(Consumer describeDbLogFilesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBLogFiles(DescribeDbLogFilesRequest.builder().applyMutation(describeDbLogFilesRequest).build());
}
/**
*
* Returns a list of DB log files for the DB instance.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)} operation.
*
*
* @param describeDbLogFilesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBLogFiles
* @see AWS API
* Documentation
*/
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(DescribeDbLogFilesRequest describeDbLogFilesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of DB log files for the DB instance.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBLogFiles(software.amazon.awssdk.services.rds.model.DescribeDbLogFilesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbLogFilesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbLogFilesRequest#builder()}
*
*
* @param describeDbLogFilesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBLogFilesMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBLogFiles
* @see AWS API
* Documentation
*/
default DescribeDBLogFilesIterable describeDBLogFilesPaginator(
Consumer describeDbLogFilesRequest) throws DbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBLogFilesPaginator(DescribeDbLogFilesRequest.builder().applyMutation(describeDbLogFilesRequest).build());
}
/**
*
* Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
* specified, the list will contain only the description of the specified DB parameter group.
*
*
* @return Result of the DescribeDBParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see #describeDBParameterGroups(DescribeDbParameterGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBParameterGroups(DescribeDbParameterGroupsRequest.builder().build());
}
/**
*
* Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
* specified, the list will contain only the description of the specified DB parameter group.
*
*
* @param describeDbParameterGroupsRequest
* @return Result of the DescribeDBParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see AWS
* API Documentation
*/
default DescribeDbParameterGroupsResponse describeDBParameterGroups(
DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbParameterGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbParameterGroupsRequest#builder()}
*
*
* @param describeDbParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBParameterGroupsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see AWS
* API Documentation
*/
default DescribeDbParameterGroupsResponse describeDBParameterGroups(
Consumer describeDbParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBParameterGroups(DescribeDbParameterGroupsRequest.builder()
.applyMutation(describeDbParameterGroupsRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see #describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)}
* operation.
*
*
* @param describeDbParameterGroupsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see AWS
* API Documentation
*/
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(
DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBParameterGroups(software.amazon.awssdk.services.rds.model.DescribeDbParameterGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbParameterGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbParameterGroupsRequest#builder()}
*
*
* @param describeDbParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBParameterGroupsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameterGroups
* @see AWS
* API Documentation
*/
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(
Consumer describeDbParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest.builder()
.applyMutation(describeDbParameterGroupsRequest).build());
}
/**
*
* Returns the detailed parameter list for a particular DB parameter group.
*
*
* @param describeDbParametersRequest
* @return Result of the DescribeDBParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameters
* @see AWS API
* Documentation
*/
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular DB parameter group.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbParametersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbParametersRequest#builder()}
*
*
* @param describeDbParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBParametersMessage.Builder} to create a
* request.
* @return Result of the DescribeDBParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameters
* @see AWS API
* Documentation
*/
default DescribeDbParametersResponse describeDBParameters(
Consumer describeDbParametersRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBParameters(DescribeDbParametersRequest.builder().applyMutation(describeDbParametersRequest).build());
}
/**
*
* Returns the detailed parameter list for a particular DB parameter group.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)}
* operation.
*
*
* @param describeDbParametersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameters
* @see AWS API
* Documentation
*/
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular DB parameter group.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBParameters(software.amazon.awssdk.services.rds.model.DescribeDbParametersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbParametersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbParametersRequest#builder()}
*
*
* @param describeDbParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBParametersMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBParameters
* @see AWS API
* Documentation
*/
default DescribeDBParametersIterable describeDBParametersPaginator(
Consumer describeDbParametersRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBParametersPaginator(DescribeDbParametersRequest.builder().applyMutation(describeDbParametersRequest)
.build());
}
/**
*
* Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
* the list will contain only the descriptions of the specified DB security group.
*
*
* @return Result of the DescribeDBSecurityGroups operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see #describeDBSecurityGroups(DescribeDbSecurityGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups() throws DbSecurityGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSecurityGroups(DescribeDbSecurityGroupsRequest.builder().build());
}
/**
*
* Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
* the list will contain only the descriptions of the specified DB security group.
*
*
* @param describeDbSecurityGroupsRequest
* @return Result of the DescribeDBSecurityGroups operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see AWS
* API Documentation
*/
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(
DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbSecurityGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbSecurityGroupsRequest#builder()}
*
*
* @param describeDbSecurityGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSecurityGroupsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBSecurityGroups operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see AWS
* API Documentation
*/
default DescribeDbSecurityGroupsResponse describeDBSecurityGroups(
Consumer describeDbSecurityGroupsRequest)
throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBSecurityGroups(DescribeDbSecurityGroupsRequest.builder().applyMutation(describeDbSecurityGroupsRequest)
.build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see #describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator() throws DbSecurityGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)}
* operation.
*
*
* @param describeDbSecurityGroupsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see AWS
* API Documentation
*/
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(
DescribeDbSecurityGroupsRequest describeDbSecurityGroupsRequest) throws DbSecurityGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSecurityGroups(software.amazon.awssdk.services.rds.model.DescribeDbSecurityGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbSecurityGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbSecurityGroupsRequest#builder()}
*
*
* @param describeDbSecurityGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSecurityGroupsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSecurityGroups
* @see AWS
* API Documentation
*/
default DescribeDBSecurityGroupsIterable describeDBSecurityGroupsPaginator(
Consumer describeDbSecurityGroupsRequest)
throws DbSecurityGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBSecurityGroupsPaginator(DescribeDbSecurityGroupsRequest.builder()
.applyMutation(describeDbSecurityGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param describeDbSnapshotAttributesRequest
* @return Result of the DescribeDBSnapshotAttributes operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbSnapshotAttributesResponse describeDBSnapshotAttributes(
DescribeDbSnapshotAttributesRequest describeDbSnapshotAttributesRequest) throws DbSnapshotNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbSnapshotAttributesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbSnapshotAttributesRequest#builder()}
*
*
* @param describeDbSnapshotAttributesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSnapshotAttributesMessage.Builder} to create
* a request.
* @return Result of the DescribeDBSnapshotAttributes operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbSnapshotAttributesResponse describeDBSnapshotAttributes(
Consumer describeDbSnapshotAttributesRequest)
throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeDBSnapshotAttributes(DescribeDbSnapshotAttributesRequest.builder()
.applyMutation(describeDbSnapshotAttributesRequest).build());
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
* @return Result of the DescribeDBSnapshots operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see #describeDBSnapshots(DescribeDbSnapshotsRequest)
* @see AWS API
* Documentation
*/
default DescribeDbSnapshotsResponse describeDBSnapshots() throws DbSnapshotNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBSnapshots(DescribeDbSnapshotsRequest.builder().build());
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
* @param describeDbSnapshotsRequest
* @return Result of the DescribeDBSnapshots operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see AWS API
* Documentation
*/
default DescribeDbSnapshotsResponse describeDBSnapshots(DescribeDbSnapshotsRequest describeDbSnapshotsRequest)
throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbSnapshotsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSnapshotsRequest#builder()}
*
*
* @param describeDbSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSnapshotsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBSnapshots operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see AWS API
* Documentation
*/
default DescribeDbSnapshotsResponse describeDBSnapshots(
Consumer describeDbSnapshotsRequest) throws DbSnapshotNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSnapshots(DescribeDbSnapshotsRequest.builder().applyMutation(describeDbSnapshotsRequest).build());
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see #describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest)
* @see AWS API
* Documentation
*/
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator() throws DbSnapshotNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest.builder().build());
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)} operation.
*
*
* @param describeDbSnapshotsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see AWS API
* Documentation
*/
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest describeDbSnapshotsRequest)
throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSnapshots(software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbSnapshotsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSnapshotsRequest#builder()}
*
*
* @param describeDbSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSnapshotsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSnapshots
* @see AWS API
* Documentation
*/
default DescribeDBSnapshotsIterable describeDBSnapshotsPaginator(
Consumer describeDbSnapshotsRequest) throws DbSnapshotNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSnapshotsPaginator(DescribeDbSnapshotsRequest.builder().applyMutation(describeDbSnapshotsRequest)
.build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see #describeDBSubnetGroups(DescribeDbSubnetGroupsRequest)
* @see AWS API
* Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeDBSubnetGroups(DescribeDbSubnetGroupsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeDbSubnetGroupsRequest
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see AWS API
* Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbSubnetGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSubnetGroupsRequest#builder()}
*
*
* @param describeDbSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSubnetGroupsMessage.Builder} to create a
* request.
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see AWS API
* Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(
Consumer describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSubnetGroups(DescribeDbSubnetGroupsRequest.builder().applyMutation(describeDbSubnetGroupsRequest)
.build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see #describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest)
* @see AWS API
* Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* @param describeDbSubnetGroupsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see AWS API
* Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(
DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbSubnetGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSubnetGroupsRequest#builder()}
*
*
* @param describeDbSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSubnetGroupsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeDBSubnetGroups
* @see AWS API
* Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(
Consumer describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest.builder()
.applyMutation(describeDbSubnetGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param describeEngineDefaultClusterParametersRequest
* @return Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultClusterParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(
DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
throws AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link DescribeEngineDefaultClusterParametersRequest.Builder} avoiding the need to create one manually via
* {@link DescribeEngineDefaultClusterParametersRequest#builder()}
*
*
* @param describeEngineDefaultClusterParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultClusterParametersMessage.Builder}
* to create a request.
* @return Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultClusterParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(
Consumer describeEngineDefaultClusterParametersRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest.builder()
.applyMutation(describeEngineDefaultClusterParametersRequest).build());
}
/**
*
* Returns the default engine and system parameter information for the specified database engine.
*
*
* @param describeEngineDefaultParametersRequest
* @return Result of the DescribeEngineDefaultParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(
DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default engine and system parameter information for the specified database engine.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEngineDefaultParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEngineDefaultParametersRequest#builder()}
*
*
* @param describeEngineDefaultParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultParametersMessage.Builder} to
* create a request.
* @return Result of the DescribeEngineDefaultParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(
Consumer describeEngineDefaultParametersRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest.builder()
.applyMutation(describeEngineDefaultParametersRequest).build());
}
/**
*
* Returns the default engine and system parameter information for the specified database engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)}
* operation.
*
*
* @param describeEngineDefaultParametersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(
DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default engine and system parameter information for the specified database engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.rds.model.DescribeEngineDefaultParametersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEngineDefaultParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEngineDefaultParametersRequest#builder()}
*
*
* @param describeEngineDefaultParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultParametersMessage.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(
Consumer describeEngineDefaultParametersRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest.builder()
.applyMutation(describeEngineDefaultParametersRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventCategories
* @see #describeEventCategories(DescribeEventCategoriesRequest)
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException,
RdsException {
return describeEventCategories(DescribeEventCategoriesRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeEventCategoriesRequest
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventCategories
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
throws AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventCategoriesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventCategoriesRequest#builder()}
*
*
* @param describeEventCategoriesRequest
* A {@link Consumer} that will call methods on {@link DescribeEventCategoriesMessage.Builder} to create a
* request.
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventCategories
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories(
Consumer describeEventCategoriesRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeEventCategories(DescribeEventCategoriesRequest.builder().applyMutation(describeEventCategoriesRequest)
.build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see #describeEventSubscriptions(DescribeEventSubscriptionsRequest)
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeEventSubscriptions(DescribeEventSubscriptionsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeEventSubscriptionsRequest
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsResponse describeEventSubscriptions(
DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventSubscriptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventSubscriptionsRequest#builder()}
*
*
* @param describeEventSubscriptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventSubscriptionsMessage.Builder} to create a
* request.
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsResponse describeEventSubscriptions(
Consumer describeEventSubscriptionsRequest)
throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeEventSubscriptions(DescribeEventSubscriptionsRequest.builder()
.applyMutation(describeEventSubscriptionsRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see #describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest)
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)}
* operation.
*
*
* @param describeEventSubscriptionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(
DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEventSubscriptions(software.amazon.awssdk.services.rds.model.DescribeEventSubscriptionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEventSubscriptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventSubscriptionsRequest#builder()}
*
*
* @param describeEventSubscriptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventSubscriptionsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEventSubscriptions
* @see AWS
* API Documentation
*/
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(
Consumer describeEventSubscriptionsRequest)
throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest.builder()
.applyMutation(describeEventSubscriptionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see #describeEvents(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, RdsException {
return describeEvents(DescribeEventsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeEventsRequest
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(Consumer describeEventsRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeEvents(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see #describeEventsPaginator(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, RdsException {
return describeEventsPaginator(DescribeEventsRequest.builder().build());
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)} operation.
*
*
* @param describeEventsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
throws AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.rds.model.DescribeEventsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(Consumer describeEventsRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeEventsPaginator(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* 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.
*
*
*
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see #describeGlobalClusters(DescribeGlobalClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersResponse describeGlobalClusters() throws GlobalClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeGlobalClusters(DescribeGlobalClustersRequest.builder().build());
}
/**
*
* 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.
*
*
*
* @param describeGlobalClustersRequest
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeGlobalClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeGlobalClustersRequest#builder()}
*
*
* @param describeGlobalClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalClustersMessage.Builder} to create a
* request.
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersResponse describeGlobalClusters(
Consumer describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeGlobalClusters(DescribeGlobalClustersRequest.builder().applyMutation(describeGlobalClustersRequest)
.build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see #describeGlobalClustersPaginator(DescribeGlobalClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersIterable describeGlobalClustersPaginator() throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeGlobalClustersPaginator(DescribeGlobalClustersRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)}
* operation.
*
*
* @param describeGlobalClustersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(
DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeGlobalClusters(software.amazon.awssdk.services.rds.model.DescribeGlobalClustersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeGlobalClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeGlobalClustersRequest#builder()}
*
*
* @param describeGlobalClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalClustersMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalClusterNotFoundException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(
Consumer describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeGlobalClustersPaginator(DescribeGlobalClustersRequest.builder()
.applyMutation(describeGlobalClustersRequest).build());
}
/**
*
* Describes all available options.
*
*
* @param describeOptionGroupOptionsRequest
* @return Result of the DescribeOptionGroupOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroupOptions
* @see AWS
* API Documentation
*/
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(
DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Describes all available options.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOptionGroupOptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeOptionGroupOptionsRequest#builder()}
*
*
* @param describeOptionGroupOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOptionGroupOptionsMessage.Builder} to create a
* request.
* @return Result of the DescribeOptionGroupOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroupOptions
* @see AWS
* API Documentation
*/
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(
Consumer describeOptionGroupOptionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeOptionGroupOptions(DescribeOptionGroupOptionsRequest.builder()
.applyMutation(describeOptionGroupOptionsRequest).build());
}
/**
*
* Describes all available options.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)}
* operation.
*
*
* @param describeOptionGroupOptionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroupOptions
* @see AWS
* API Documentation
*/
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(
DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Describes all available options.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOptionGroupOptions(software.amazon.awssdk.services.rds.model.DescribeOptionGroupOptionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeOptionGroupOptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeOptionGroupOptionsRequest#builder()}
*
*
* @param describeOptionGroupOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOptionGroupOptionsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroupOptions
* @see AWS
* API Documentation
*/
default DescribeOptionGroupOptionsIterable describeOptionGroupOptionsPaginator(
Consumer describeOptionGroupOptionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeOptionGroupOptionsPaginator(DescribeOptionGroupOptionsRequest.builder()
.applyMutation(describeOptionGroupOptionsRequest).build());
}
/**
*
* Describes the available option groups.
*
*
* @return Result of the DescribeOptionGroups operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see #describeOptionGroups(DescribeOptionGroupsRequest)
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsResponse describeOptionGroups() throws OptionGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return describeOptionGroups(DescribeOptionGroupsRequest.builder().build());
}
/**
*
* Describes the available option groups.
*
*
* @param describeOptionGroupsRequest
* @return Result of the DescribeOptionGroups operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsResponse describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Describes the available option groups.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOptionGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeOptionGroupsRequest#builder()}
*
*
* @param describeOptionGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeOptionGroupsMessage.Builder} to create a
* request.
* @return Result of the DescribeOptionGroups operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsResponse describeOptionGroups(
Consumer describeOptionGroupsRequest) throws OptionGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeOptionGroups(DescribeOptionGroupsRequest.builder().applyMutation(describeOptionGroupsRequest).build());
}
/**
*
* Describes the available option groups.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see #describeOptionGroupsPaginator(DescribeOptionGroupsRequest)
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsIterable describeOptionGroupsPaginator() throws OptionGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeOptionGroupsPaginator(DescribeOptionGroupsRequest.builder().build());
}
/**
*
* Describes the available option groups.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)}
* operation.
*
*
* @param describeOptionGroupsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsIterable describeOptionGroupsPaginator(DescribeOptionGroupsRequest describeOptionGroupsRequest)
throws OptionGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Describes the available option groups.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOptionGroups(software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeOptionGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeOptionGroupsRequest#builder()}
*
*
* @param describeOptionGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeOptionGroupsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOptionGroups
* @see AWS API
* Documentation
*/
default DescribeOptionGroupsIterable describeOptionGroupsPaginator(
Consumer describeOptionGroupsRequest) throws OptionGroupNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeOptionGroupsPaginator(DescribeOptionGroupsRequest.builder().applyMutation(describeOptionGroupsRequest)
.build());
}
/**
*
* Returns a list of orderable DB instance options for the specified engine.
*
*
* @param describeOrderableDbInstanceOptionsRequest
* @return Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(
DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of orderable DB instance options for the specified engine.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOrderableDbInstanceOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeOrderableDbInstanceOptionsRequest#builder()}
*
*
* @param describeOrderableDbInstanceOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOrderableDBInstanceOptionsMessage.Builder} to
* create a request.
* @return Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(
Consumer describeOrderableDbInstanceOptionsRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest.builder()
.applyMutation(describeOrderableDbInstanceOptionsRequest).build());
}
/**
*
* Returns a list of orderable DB instance options for the specified engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)}
* operation.
*
*
* @param describeOrderableDbInstanceOptionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(
DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of orderable DB instance options for the specified engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOrderableDBInstanceOptions(software.amazon.awssdk.services.rds.model.DescribeOrderableDbInstanceOptionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeOrderableDbInstanceOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeOrderableDbInstanceOptionsRequest#builder()}
*
*
* @param describeOrderableDbInstanceOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOrderableDBInstanceOptionsMessage.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(
Consumer describeOrderableDbInstanceOptionsRequest)
throws AwsServiceException, SdkClientException, RdsException {
return describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest.builder()
.applyMutation(describeOrderableDbInstanceOptionsRequest).build());
}
/**
*
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*
*
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribePendingMaintenanceActions
* @see #describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest.builder().build());
}
/**
*
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*
*
* @param describePendingMaintenanceActionsRequest
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(
DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribePendingMaintenanceActionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribePendingMaintenanceActionsRequest#builder()}
*
*
* @param describePendingMaintenanceActionsRequest
* A {@link Consumer} that will call methods on {@link DescribePendingMaintenanceActionsMessage.Builder} to
* create a request.
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(
Consumer describePendingMaintenanceActionsRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest.builder()
.applyMutation(describePendingMaintenanceActionsRequest).build());
}
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
* @return Result of the DescribeReservedDBInstances operation returned by the service.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see #describeReservedDBInstances(DescribeReservedDbInstancesRequest)
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesResponse describeReservedDBInstances() throws ReservedDbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstances(DescribeReservedDbInstancesRequest.builder().build());
}
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
* @param describeReservedDbInstancesRequest
* @return Result of the DescribeReservedDBInstances operation returned by the service.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesResponse describeReservedDBInstances(
DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeReservedDbInstancesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeReservedDbInstancesRequest#builder()}
*
*
* @param describeReservedDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedDBInstancesMessage.Builder} to create
* a request.
* @return Result of the DescribeReservedDBInstances operation returned by the service.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesResponse describeReservedDBInstances(
Consumer describeReservedDbInstancesRequest)
throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstances(DescribeReservedDbInstancesRequest.builder()
.applyMutation(describeReservedDbInstancesRequest).build());
}
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see #describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest)
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator()
throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest.builder().build());
}
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)}
* operation.
*
*
* @param describeReservedDbInstancesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(
DescribeReservedDbInstancesRequest describeReservedDbInstancesRequest) throws ReservedDbInstanceNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstances(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeReservedDbInstancesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeReservedDbInstancesRequest#builder()}
*
*
* @param describeReservedDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedDBInstancesMessage.Builder} to create
* a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstanceNotFoundException
* The specified reserved DB Instance not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstances
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesIterable describeReservedDBInstancesPaginator(
Consumer describeReservedDbInstancesRequest)
throws ReservedDbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesPaginator(DescribeReservedDbInstancesRequest.builder()
.applyMutation(describeReservedDbInstancesRequest).build());
}
/**
*
* Lists available reserved DB instance offerings.
*
*
* @return Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see #describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest)
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings()
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest.builder().build());
}
/**
*
* Lists available reserved DB instance offerings.
*
*
* @param describeReservedDbInstancesOfferingsRequest
* @return Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings(
DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest)
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Lists available reserved DB instance offerings.
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeReservedDbInstancesOfferingsRequest.Builder} avoiding the need to create one manually via
* {@link DescribeReservedDbInstancesOfferingsRequest#builder()}
*
*
* @param describeReservedDbInstancesOfferingsRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedDBInstancesOfferingsMessage.Builder}
* to create a request.
* @return Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see AWS API Documentation
*/
default DescribeReservedDbInstancesOfferingsResponse describeReservedDBInstancesOfferings(
Consumer describeReservedDbInstancesOfferingsRequest)
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesOfferings(DescribeReservedDbInstancesOfferingsRequest.builder()
.applyMutation(describeReservedDbInstancesOfferingsRequest).build());
}
/**
*
* Lists available reserved DB instance offerings.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see #describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest)
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator()
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest.builder().build());
}
/**
*
* Lists available reserved DB instance offerings.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)}
* operation.
*
*
* @param describeReservedDbInstancesOfferingsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(
DescribeReservedDbInstancesOfferingsRequest describeReservedDbInstancesOfferingsRequest)
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Lists available reserved DB instance offerings.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeReservedDBInstancesOfferings(software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesOfferingsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the
* {@link DescribeReservedDbInstancesOfferingsRequest.Builder} avoiding the need to create one manually via
* {@link DescribeReservedDbInstancesOfferingsRequest#builder()}
*
*
* @param describeReservedDbInstancesOfferingsRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedDBInstancesOfferingsMessage.Builder}
* to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeReservedDBInstancesOfferings
* @see AWS API Documentation
*/
default DescribeReservedDBInstancesOfferingsIterable describeReservedDBInstancesOfferingsPaginator(
Consumer describeReservedDbInstancesOfferingsRequest)
throws ReservedDbInstancesOfferingNotFoundException, AwsServiceException, SdkClientException, RdsException {
return describeReservedDBInstancesOfferingsPaginator(DescribeReservedDbInstancesOfferingsRequest.builder()
.applyMutation(describeReservedDbInstancesOfferingsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeSourceRegions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeSourceRegions
* @see #describeSourceRegions(DescribeSourceRegionsRequest)
* @see AWS API
* Documentation
*/
default DescribeSourceRegionsResponse describeSourceRegions() throws AwsServiceException, SdkClientException, RdsException {
return describeSourceRegions(DescribeSourceRegionsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeSourceRegionsRequest
* @return Result of the DescribeSourceRegions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeSourceRegions
* @see AWS API
* Documentation
*/
default DescribeSourceRegionsResponse describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest)
throws AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeSourceRegionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSourceRegionsRequest#builder()}
*
*
* @param describeSourceRegionsRequest
* A {@link Consumer} that will call methods on {@link DescribeSourceRegionsMessage.Builder} to create a
* request.
* @return Result of the DescribeSourceRegions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeSourceRegions
* @see AWS API
* Documentation
*/
default DescribeSourceRegionsResponse describeSourceRegions(
Consumer describeSourceRegionsRequest) throws AwsServiceException,
SdkClientException, RdsException {
return describeSourceRegions(DescribeSourceRegionsRequest.builder().applyMutation(describeSourceRegionsRequest).build());
}
/**
*
* You can call DescribeValidDBInstanceModifications
to learn what modifications you can make to your
* DB instance. You can use this information when you call ModifyDBInstance
.
*
*
* @param describeValidDbInstanceModificationsRequest
* @return Result of the DescribeValidDBInstanceModifications operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeValidDBInstanceModifications
* @see AWS API Documentation
*/
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(
DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link DescribeValidDbInstanceModificationsRequest.Builder} avoiding the need to create one manually via
* {@link DescribeValidDbInstanceModificationsRequest#builder()}
*
*
* @param describeValidDbInstanceModificationsRequest
* A {@link Consumer} that will call methods on {@link DescribeValidDBInstanceModificationsMessage.Builder}
* to create a request.
* @return Result of the DescribeValidDBInstanceModifications operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DescribeValidDBInstanceModifications
* @see AWS API Documentation
*/
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(
Consumer describeValidDbInstanceModificationsRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
return describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest.builder()
.applyMutation(describeValidDbInstanceModificationsRequest).build());
}
/**
*
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*
*
* @param downloadDbLogFilePortionRequest
* @return Result of the DownloadDBLogFilePortion operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbLogFileNotFoundException
* LogFileName doesn't refer to an existing DB log file.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DownloadDBLogFilePortion
* @see AWS
* API Documentation
*/
default DownloadDbLogFilePortionResponse downloadDBLogFilePortion(
DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException,
DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DownloadDbLogFilePortionRequest.Builder} avoiding
* the need to create one manually via {@link DownloadDbLogFilePortionRequest#builder()}
*
*
* @param downloadDbLogFilePortionRequest
* A {@link Consumer} that will call methods on {@link DownloadDBLogFilePortionMessage.Builder} to create a
* request.
* @return Result of the DownloadDBLogFilePortion operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbLogFileNotFoundException
* LogFileName doesn't refer to an existing DB log file.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DownloadDBLogFilePortion
* @see AWS
* API Documentation
*/
default DownloadDbLogFilePortionResponse downloadDBLogFilePortion(
Consumer downloadDbLogFilePortionRequest)
throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException {
return downloadDBLogFilePortion(DownloadDbLogFilePortionRequest.builder().applyMutation(downloadDbLogFilePortionRequest)
.build());
}
/**
*
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)}
* operation.
*
*
* @param downloadDbLogFilePortionRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbLogFileNotFoundException
* LogFileName doesn't refer to an existing DB log file.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DownloadDBLogFilePortion
* @see AWS
* API Documentation
*/
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(
DownloadDbLogFilePortionRequest downloadDbLogFilePortionRequest) throws DbInstanceNotFoundException,
DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #downloadDBLogFilePortion(software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DownloadDbLogFilePortionRequest.Builder} avoiding
* the need to create one manually via {@link DownloadDbLogFilePortionRequest#builder()}
*
*
* @param downloadDbLogFilePortionRequest
* A {@link Consumer} that will call methods on {@link DownloadDBLogFilePortionMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbLogFileNotFoundException
* LogFileName doesn't refer to an existing DB log file.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.DownloadDBLogFilePortion
* @see AWS
* API Documentation
*/
default DownloadDBLogFilePortionIterable downloadDBLogFilePortionPaginator(
Consumer downloadDbLogFilePortionRequest)
throws DbInstanceNotFoundException, DbLogFileNotFoundException, AwsServiceException, SdkClientException, RdsException {
return downloadDBLogFilePortionPaginator(DownloadDbLogFilePortionRequest.builder()
.applyMutation(downloadDbLogFilePortionRequest).build());
}
/**
*
* 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.
*
*
*
* @param failoverDbClusterRequest
* @return Result of the FailoverDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.FailoverDBCluster
* @see AWS API
* Documentation
*/
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link FailoverDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link FailoverDbClusterRequest#builder()}
*
*
* @param failoverDbClusterRequest
* A {@link Consumer} that will call methods on {@link FailoverDBClusterMessage.Builder} to create a request.
* @return Result of the FailoverDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.FailoverDBCluster
* @see AWS API
* Documentation
*/
default FailoverDbClusterResponse failoverDBCluster(Consumer failoverDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
return failoverDBCluster(FailoverDbClusterRequest.builder().applyMutation(failoverDbClusterRequest).build());
}
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceMessage.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws DbInstanceNotFoundException,
DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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.
*
*
*
* @param modifyCurrentDbClusterCapacityRequest
* @return Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterCapacityException
* Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
* 2
, 4
, 8
, 16
, 32
, 64
,
* 128
, and 256
.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyCurrentDBClusterCapacity
* @see AWS API Documentation
*/
default ModifyCurrentDbClusterCapacityResponse modifyCurrentDBClusterCapacity(
ModifyCurrentDbClusterCapacityRequest modifyCurrentDbClusterCapacityRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, InvalidDbClusterCapacityException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyCurrentDbClusterCapacityRequest.Builder}
* avoiding the need to create one manually via {@link ModifyCurrentDbClusterCapacityRequest#builder()}
*
*
* @param modifyCurrentDbClusterCapacityRequest
* A {@link Consumer} that will call methods on {@link ModifyCurrentDBClusterCapacityMessage.Builder} to
* create a request.
* @return Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterCapacityException
* Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
* 2
, 4
, 8
, 16
, 32
, 64
,
* 128
, and 256
.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyCurrentDBClusterCapacity
* @see AWS API Documentation
*/
default ModifyCurrentDbClusterCapacityResponse modifyCurrentDBClusterCapacity(
Consumer modifyCurrentDbClusterCapacityRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbClusterCapacityException,
AwsServiceException, SdkClientException, RdsException {
return modifyCurrentDBClusterCapacity(ModifyCurrentDbClusterCapacityRequest.builder()
.applyMutation(modifyCurrentDbClusterCapacityRequest).build());
}
/**
*
* 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.
*
*
*
* @param modifyDbClusterRequest
* @return Result of the ModifyDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBCluster
* @see AWS API
* Documentation
*/
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException,
InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException,
InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link ModifyDbClusterRequest#builder()}
*
*
* @param modifyDbClusterRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterMessage.Builder} to create a request.
* @return Result of the ModifyDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBCluster
* @see AWS API
* Documentation
*/
default ModifyDbClusterResponse modifyDBCluster(Consumer modifyDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException,
InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException,
InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException,
RdsException {
return modifyDBCluster(ModifyDbClusterRequest.builder().applyMutation(modifyDbClusterRequest).build());
}
/**
*
* Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyDbClusterEndpointRequest
* @return Result of the ModifyDBClusterEndpoint operation returned by the service.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DbClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterEndpoint
* @see AWS
* API Documentation
*/
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest)
throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException,
DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterEndpointRequest.Builder} avoiding
* the need to create one manually via {@link ModifyDbClusterEndpointRequest#builder()}
*
*
* @param modifyDbClusterEndpointRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterEndpointMessage.Builder} to create a
* request.
* @return Result of the ModifyDBClusterEndpoint operation returned by the service.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DbClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterEndpoint
* @see AWS
* API Documentation
*/
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(
Consumer modifyDbClusterEndpointRequest)
throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException,
DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, RdsException {
return modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest.builder().applyMutation(modifyDbClusterEndpointRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param modifyDbClusterParameterGroupRequest
* @return Result of the ModifyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterParameterGroup
* @see AWS API Documentation
*/
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(
ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException,
InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link ModifyDbClusterParameterGroupRequest#builder()}
*
*
* @param modifyDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterParameterGroupMessage.Builder} to
* create a request.
* @return Result of the ModifyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterParameterGroup
* @see AWS API Documentation
*/
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(
Consumer modifyDbClusterParameterGroupRequest)
throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException,
SdkClientException, RdsException {
return modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest.builder()
.applyMutation(modifyDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param modifyDbClusterSnapshotAttributeRequest
* @return Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterSnapshotAttribute
* @see AWS API Documentation
*/
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(
ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException,
SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterSnapshotAttributeRequest.Builder}
* avoiding the need to create one manually via {@link ModifyDbClusterSnapshotAttributeRequest#builder()}
*
*
* @param modifyDbClusterSnapshotAttributeRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterSnapshotAttributeMessage.Builder} to
* create a request.
* @return Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBClusterSnapshotAttribute
* @see AWS API Documentation
*/
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(
Consumer modifyDbClusterSnapshotAttributeRequest)
throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException,
SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
return modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest.builder()
.applyMutation(modifyDbClusterSnapshotAttributeRequest).build());
}
/**
*
* 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
.
*
*
* @param modifyDbInstanceRequest
* @return Result of the ModifyDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbUpgradeDependencyFailureException
* The DB upgrade failed because a resource the DB depends on can't be modified.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBInstance
* @see AWS API
* Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link ModifyDbInstanceRequest#builder()}
*
*
* @param modifyDbInstanceRequest
* A {@link Consumer} that will call methods on {@link ModifyDBInstanceMessage.Builder} to create a request.
* @return Result of the ModifyDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DbUpgradeDependencyFailureException
* The DB upgrade failed because a resource the DB depends on can't be modified.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBInstance
* @see AWS API
* Documentation
*/
default ModifyDbInstanceResponse modifyDBInstance(Consumer modifyDbInstanceRequest)
throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException,
DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException,
InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException,
ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException,
StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException,
DomainNotFoundException, AwsServiceException, SdkClientException, RdsException {
return modifyDBInstance(ModifyDbInstanceRequest.builder().applyMutation(modifyDbInstanceRequest).build());
}
/**
*
* 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.
*
*
*
* @param modifyDbParameterGroupRequest
* @return Result of the ModifyDBParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBParameterGroup
* @see AWS API
* Documentation
*/
default ModifyDbParameterGroupResponse modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest)
throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbParameterGroupRequest.Builder} avoiding the
* need to create one manually via {@link ModifyDbParameterGroupRequest#builder()}
*
*
* @param modifyDbParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyDBParameterGroupMessage.Builder} to create a
* request.
* @return Result of the ModifyDBParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBParameterGroup
* @see AWS API
* Documentation
*/
default ModifyDbParameterGroupResponse modifyDBParameterGroup(
Consumer modifyDbParameterGroupRequest)
throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException,
SdkClientException, RdsException {
return modifyDBParameterGroup(ModifyDbParameterGroupRequest.builder().applyMutation(modifyDbParameterGroupRequest)
.build());
}
/**
*
* 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.
*
*
* @param modifyDbSnapshotRequest
* @return Result of the ModifyDBSnapshot operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSnapshot
* @see AWS API
* Documentation
*/
default ModifyDbSnapshotResponse modifyDBSnapshot(ModifyDbSnapshotRequest modifyDbSnapshotRequest)
throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbSnapshotRequest.Builder} avoiding the need
* to create one manually via {@link ModifyDbSnapshotRequest#builder()}
*
*
* @param modifyDbSnapshotRequest
* A {@link Consumer} that will call methods on {@link ModifyDBSnapshotMessage.Builder} to create a request.
* @return Result of the ModifyDBSnapshot operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSnapshot
* @see AWS API
* Documentation
*/
default ModifyDbSnapshotResponse modifyDBSnapshot(Consumer modifyDbSnapshotRequest)
throws DbSnapshotNotFoundException, AwsServiceException, SdkClientException, RdsException {
return modifyDBSnapshot(ModifyDbSnapshotRequest.builder().applyMutation(modifyDbSnapshotRequest).build());
}
/**
*
* 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.
*
*
* @param modifyDbSnapshotAttributeRequest
* @return Result of the ModifyDBSnapshotAttribute operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSnapshotAttribute
* @see AWS
* API Documentation
*/
default ModifyDbSnapshotAttributeResponse modifyDBSnapshotAttribute(
ModifyDbSnapshotAttributeRequest modifyDbSnapshotAttributeRequest) throws DbSnapshotNotFoundException,
InvalidDbSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbSnapshotAttributeRequest.Builder} avoiding
* the need to create one manually via {@link ModifyDbSnapshotAttributeRequest#builder()}
*
*
* @param modifyDbSnapshotAttributeRequest
* A {@link Consumer} that will call methods on {@link ModifyDBSnapshotAttributeMessage.Builder} to create a
* request.
* @return Result of the ModifyDBSnapshotAttribute operation returned by the service.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSnapshotAttribute
* @see AWS
* API Documentation
*/
default ModifyDbSnapshotAttributeResponse modifyDBSnapshotAttribute(
Consumer modifyDbSnapshotAttributeRequest)
throws DbSnapshotNotFoundException, InvalidDbSnapshotStateException, SharedSnapshotQuotaExceededException,
AwsServiceException, SdkClientException, RdsException {
return modifyDBSnapshotAttribute(ModifyDbSnapshotAttributeRequest.builder()
.applyMutation(modifyDbSnapshotAttributeRequest).build());
}
/**
*
* Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in
* the AWS Region.
*
*
* @param modifyDbSubnetGroupRequest
* @return Result of the ModifyDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws SubnetAlreadyInUseException
* The DB subnet is already in use in the Availability Zone.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSubnetGroup
* @see AWS API
* Documentation
*/
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link ModifyDbSubnetGroupRequest#builder()}
*
*
* @param modifyDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyDBSubnetGroupMessage.Builder} to create a
* request.
* @return Result of the ModifyDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws SubnetAlreadyInUseException
* The DB subnet is already in use in the Availability Zone.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyDBSubnetGroup
* @see AWS API
* Documentation
*/
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(
Consumer modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException,
DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException,
InvalidSubnetException, AwsServiceException, SdkClientException, RdsException {
return modifyDBSubnetGroup(ModifyDbSubnetGroupRequest.builder().applyMutation(modifyDbSubnetGroupRequest).build());
}
/**
*
* 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.
*
*
* @param modifyEventSubscriptionRequest
* @return Result of the ModifyEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SnsInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SnsTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyEventSubscription
* @see AWS
* API Documentation
*/
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link ModifyEventSubscriptionRequest#builder()}
*
*
* @param modifyEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link ModifyEventSubscriptionMessage.Builder} to create a
* request.
* @return Result of the ModifyEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SnsInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SnsTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyEventSubscription
* @see AWS
* API Documentation
*/
default ModifyEventSubscriptionResponse modifyEventSubscription(
Consumer modifyEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return modifyEventSubscription(ModifyEventSubscriptionRequest.builder().applyMutation(modifyEventSubscriptionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param modifyGlobalClusterRequest
* @return Result of the ModifyGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyGlobalCluster
* @see AWS API
* Documentation
*/
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link ModifyGlobalClusterRequest#builder()}
*
*
* @param modifyGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link ModifyGlobalClusterMessage.Builder} to create a
* request.
* @return Result of the ModifyGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyGlobalCluster
* @see AWS API
* Documentation
*/
default ModifyGlobalClusterResponse modifyGlobalCluster(
Consumer modifyGlobalClusterRequest) throws GlobalClusterNotFoundException,
InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, RdsException {
return modifyGlobalCluster(ModifyGlobalClusterRequest.builder().applyMutation(modifyGlobalClusterRequest).build());
}
/**
*
* Modifies an existing option group.
*
*
* @param modifyOptionGroupRequest
* @return Result of the ModifyOptionGroup operation returned by the service.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyOptionGroup
* @see AWS API
* Documentation
*/
default ModifyOptionGroupResponse modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
throws InvalidOptionGroupStateException, OptionGroupNotFoundException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies an existing option group.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyOptionGroupRequest.Builder} avoiding the need
* to create one manually via {@link ModifyOptionGroupRequest#builder()}
*
*
* @param modifyOptionGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyOptionGroupMessage.Builder} to create a request.
* @return Result of the ModifyOptionGroup operation returned by the service.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ModifyOptionGroup
* @see AWS API
* Documentation
*/
default ModifyOptionGroupResponse modifyOptionGroup(Consumer modifyOptionGroupRequest)
throws InvalidOptionGroupStateException, OptionGroupNotFoundException, AwsServiceException, SdkClientException,
RdsException {
return modifyOptionGroup(ModifyOptionGroupRequest.builder().applyMutation(modifyOptionGroupRequest).build());
}
/**
*
* 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.
*
*
*
*
*
* @param promoteReadReplicaRequest
* @return Result of the PromoteReadReplica operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PromoteReadReplica
* @see AWS API
* Documentation
*/
default PromoteReadReplicaResponse promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PromoteReadReplicaRequest.Builder} avoiding the
* need to create one manually via {@link PromoteReadReplicaRequest#builder()}
*
*
* @param promoteReadReplicaRequest
* A {@link Consumer} that will call methods on {@link PromoteReadReplicaMessage.Builder} to create a
* request.
* @return Result of the PromoteReadReplica operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PromoteReadReplica
* @see AWS API
* Documentation
*/
default PromoteReadReplicaResponse promoteReadReplica(Consumer promoteReadReplicaRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
RdsException {
return promoteReadReplica(PromoteReadReplicaRequest.builder().applyMutation(promoteReadReplicaRequest).build());
}
/**
*
* Promotes a Read Replica DB cluster to a standalone DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param promoteReadReplicaDbClusterRequest
* @return Result of the PromoteReadReplicaDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PromoteReadReplicaDBCluster
* @see AWS API Documentation
*/
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(
PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PromoteReadReplicaDbClusterRequest.Builder}
* avoiding the need to create one manually via {@link PromoteReadReplicaDbClusterRequest#builder()}
*
*
* @param promoteReadReplicaDbClusterRequest
* A {@link Consumer} that will call methods on {@link PromoteReadReplicaDBClusterMessage.Builder} to create
* a request.
* @return Result of the PromoteReadReplicaDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PromoteReadReplicaDBCluster
* @see AWS API Documentation
*/
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(
Consumer promoteReadReplicaDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException,
RdsException {
return promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest.builder()
.applyMutation(promoteReadReplicaDbClusterRequest).build());
}
/**
*
* Purchases a reserved DB instance offering.
*
*
* @param purchaseReservedDbInstancesOfferingRequest
* @return Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws ReservedDbInstanceAlreadyExistsException
* User already has a reservation with the given identifier.
* @throws ReservedDbInstanceQuotaExceededException
* Request would exceed the user's DB Instance quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PurchaseReservedDBInstancesOffering
* @see AWS API Documentation
*/
default PurchaseReservedDbInstancesOfferingResponse purchaseReservedDBInstancesOffering(
PurchaseReservedDbInstancesOfferingRequest purchaseReservedDbInstancesOfferingRequest)
throws ReservedDbInstancesOfferingNotFoundException, ReservedDbInstanceAlreadyExistsException,
ReservedDbInstanceQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Purchases a reserved DB instance offering.
*
*
*
* This is a convenience which creates an instance of the {@link PurchaseReservedDbInstancesOfferingRequest.Builder}
* avoiding the need to create one manually via {@link PurchaseReservedDbInstancesOfferingRequest#builder()}
*
*
* @param purchaseReservedDbInstancesOfferingRequest
* A {@link Consumer} that will call methods on {@link PurchaseReservedDBInstancesOfferingMessage.Builder} to
* create a request.
* @return Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
* @throws ReservedDbInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws ReservedDbInstanceAlreadyExistsException
* User already has a reservation with the given identifier.
* @throws ReservedDbInstanceQuotaExceededException
* Request would exceed the user's DB Instance quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.PurchaseReservedDBInstancesOffering
* @see AWS API Documentation
*/
default PurchaseReservedDbInstancesOfferingResponse purchaseReservedDBInstancesOffering(
Consumer purchaseReservedDbInstancesOfferingRequest)
throws ReservedDbInstancesOfferingNotFoundException, ReservedDbInstanceAlreadyExistsException,
ReservedDbInstanceQuotaExceededException, AwsServiceException, SdkClientException, RdsException {
return purchaseReservedDBInstancesOffering(PurchaseReservedDbInstancesOfferingRequest.builder()
.applyMutation(purchaseReservedDbInstancesOfferingRequest).build());
}
/**
*
* 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.
*
*
* @param rebootDbInstanceRequest
* @return Result of the RebootDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RebootDBInstance
* @see AWS API
* Documentation
*/
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RebootDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link RebootDbInstanceRequest#builder()}
*
*
* @param rebootDbInstanceRequest
* A {@link Consumer} that will call methods on {@link RebootDBInstanceMessage.Builder} to create a request.
* @return Result of the RebootDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RebootDBInstance
* @see AWS API
* Documentation
*/
default RebootDbInstanceResponse rebootDBInstance(Consumer rebootDbInstanceRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
RdsException {
return rebootDBInstance(RebootDbInstanceRequest.builder().applyMutation(rebootDbInstanceRequest).build());
}
/**
*
* 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.
*
*
*
* @param removeFromGlobalClusterRequest
* @return Result of the RemoveFromGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RemoveFromGlobalClusterRequest.Builder} avoiding
* the need to create one manually via {@link RemoveFromGlobalClusterRequest#builder()}
*
*
* @param removeFromGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link RemoveFromGlobalClusterMessage.Builder} to create a
* request.
* @return Result of the RemoveFromGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(
Consumer removeFromGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException,
AwsServiceException, SdkClientException, RdsException {
return removeFromGlobalCluster(RemoveFromGlobalClusterRequest.builder().applyMutation(removeFromGlobalClusterRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param removeRoleFromDbClusterRequest
* @return Result of the RemoveRoleFromDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterRoleNotFoundException
* The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveRoleFromDBCluster
* @see AWS
* API Documentation
*/
default RemoveRoleFromDBClusterResponse removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest)
throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException,
AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RemoveRoleFromDbClusterRequest.Builder} avoiding
* the need to create one manually via {@link RemoveRoleFromDbClusterRequest#builder()}
*
*
* @param removeRoleFromDbClusterRequest
* A {@link Consumer} that will call methods on {@link RemoveRoleFromDBClusterMessage.Builder} to create a
* request.
* @return Result of the RemoveRoleFromDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterRoleNotFoundException
* The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveRoleFromDBCluster
* @see AWS
* API Documentation
*/
default RemoveRoleFromDBClusterResponse removeRoleFromDBCluster(
Consumer removeRoleFromDbClusterRequest) throws DbClusterNotFoundException,
DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException {
return removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest.builder().applyMutation(removeRoleFromDbClusterRequest)
.build());
}
/**
*
* Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
*
*
* @param removeRoleFromDbInstanceRequest
* @return Result of the RemoveRoleFromDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbInstanceRoleNotFoundException
* The specified RoleArn value doesn't match the specifed feature for the DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveRoleFromDBInstance
* @see AWS
* API Documentation
*/
default RemoveRoleFromDBInstanceResponse removeRoleFromDBInstance(
RemoveRoleFromDbInstanceRequest removeRoleFromDbInstanceRequest) throws DbInstanceNotFoundException,
DbInstanceRoleNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveRoleFromDbInstanceRequest.Builder} avoiding
* the need to create one manually via {@link RemoveRoleFromDbInstanceRequest#builder()}
*
*
* @param removeRoleFromDbInstanceRequest
* A {@link Consumer} that will call methods on {@link RemoveRoleFromDBInstanceMessage.Builder} to create a
* request.
* @return Result of the RemoveRoleFromDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbInstanceRoleNotFoundException
* The specified RoleArn value doesn't match the specifed feature for the DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveRoleFromDBInstance
* @see AWS
* API Documentation
*/
default RemoveRoleFromDBInstanceResponse removeRoleFromDBInstance(
Consumer removeRoleFromDbInstanceRequest)
throws DbInstanceNotFoundException, DbInstanceRoleNotFoundException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
return removeRoleFromDBInstance(RemoveRoleFromDbInstanceRequest.builder().applyMutation(removeRoleFromDbInstanceRequest)
.build());
}
/**
*
* Removes a source identifier from an existing RDS event notification subscription.
*
*
* @param removeSourceIdentifierFromSubscriptionRequest
* @return Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveSourceIdentifierFromSubscription
* @see AWS API Documentation
*/
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(
RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a source identifier from an existing RDS event notification subscription.
*
*
*
* This is a convenience which creates an instance of the
* {@link RemoveSourceIdentifierFromSubscriptionRequest.Builder} avoiding the need to create one manually via
* {@link RemoveSourceIdentifierFromSubscriptionRequest#builder()}
*
*
* @param removeSourceIdentifierFromSubscriptionRequest
* A {@link Consumer} that will call methods on {@link RemoveSourceIdentifierFromSubscriptionMessage.Builder}
* to create a request.
* @return Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveSourceIdentifierFromSubscription
* @see AWS API Documentation
*/
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(
Consumer removeSourceIdentifierFromSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest.builder()
.applyMutation(removeSourceIdentifierFromSubscriptionRequest).build());
}
/**
*
* 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.
*
*
* @param removeTagsFromResourceRequest
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveTagsFromResource
* @see AWS API
* Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RemoveTagsFromResourceRequest.Builder} avoiding the
* need to create one manually via {@link RemoveTagsFromResourceRequest#builder()}
*
*
* @param removeTagsFromResourceRequest
* A {@link Consumer} that will call methods on {@link RemoveTagsFromResourceMessage.Builder} to create a
* request.
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RemoveTagsFromResource
* @see AWS API
* Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(
Consumer removeTagsFromResourceRequest) throws DbInstanceNotFoundException,
DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, RdsException {
return removeTagsFromResource(RemoveTagsFromResourceRequest.builder().applyMutation(removeTagsFromResourceRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param resetDbClusterParameterGroupRequest
* @return Result of the ResetDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ResetDBClusterParameterGroup
* @see AWS API Documentation
*/
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(
ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ResetDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link ResetDbClusterParameterGroupRequest#builder()}
*
*
* @param resetDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ResetDBClusterParameterGroupMessage.Builder} to create
* a request.
* @return Result of the ResetDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ResetDBClusterParameterGroup
* @see AWS API Documentation
*/
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(
Consumer resetDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest.builder()
.applyMutation(resetDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
* @param resetDbParameterGroupRequest
* @return Result of the ResetDBParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ResetDBParameterGroup
* @see AWS API
* Documentation
*/
default ResetDbParameterGroupResponse resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ResetDbParameterGroupRequest.Builder} avoiding the
* need to create one manually via {@link ResetDbParameterGroupRequest#builder()}
*
*
* @param resetDbParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ResetDBParameterGroupMessage.Builder} to create a
* request.
* @return Result of the ResetDBParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.ResetDBParameterGroup
* @see AWS API
* Documentation
*/
default ResetDbParameterGroupResponse resetDBParameterGroup(
Consumer resetDbParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, RdsException {
return resetDBParameterGroup(ResetDbParameterGroupRequest.builder().applyMutation(resetDbParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param restoreDbClusterFromS3Request
* @return Result of the RestoreDBClusterFromS3 operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws 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.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterFromS3
* @see AWS API
* Documentation
*/
default RestoreDbClusterFromS3Response restoreDBClusterFromS3(RestoreDbClusterFromS3Request restoreDbClusterFromS3Request)
throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException,
InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidS3BucketException,
DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException,
InsufficientStorageClusterCapacityException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbClusterFromS3Request.Builder} avoiding the
* need to create one manually via {@link RestoreDbClusterFromS3Request#builder()}
*
*
* @param restoreDbClusterFromS3Request
* A {@link Consumer} that will call methods on {@link RestoreDBClusterFromS3Message.Builder} to create a
* request.
* @return Result of the RestoreDBClusterFromS3 operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws 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.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterFromS3
* @see AWS API
* Documentation
*/
default RestoreDbClusterFromS3Response restoreDBClusterFromS3(
Consumer restoreDbClusterFromS3Request)
throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException,
InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidS3BucketException,
DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException,
InsufficientStorageClusterCapacityException, AwsServiceException, SdkClientException, RdsException {
return restoreDBClusterFromS3(RestoreDbClusterFromS3Request.builder().applyMutation(restoreDbClusterFromS3Request)
.build());
}
/**
*
* 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.
*
*
*
* @param restoreDbClusterFromSnapshotRequest
* @return Result of the RestoreDBClusterFromSnapshot operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InsufficientDbClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterFromSnapshot
* @see AWS API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbClusterFromSnapshotRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbClusterFromSnapshotRequest#builder()}
*
*
* @param restoreDbClusterFromSnapshotRequest
* A {@link Consumer} that will call methods on {@link RestoreDBClusterFromSnapshotMessage.Builder} to create
* a request.
* @return Result of the RestoreDBClusterFromSnapshot operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InsufficientDbClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterFromSnapshot
* @see AWS API Documentation
*/
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(
Consumer restoreDbClusterFromSnapshotRequest)
throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException,
InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException,
InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException,
InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException,
DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest.builder()
.applyMutation(restoreDbClusterFromSnapshotRequest).build());
}
/**
*
* 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.
*
*
*
* @param restoreDbClusterToPointInTimeRequest
* @return Result of the RestoreDBClusterToPointInTime operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InsufficientDbClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterToPointInTime
* @see AWS API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbClusterToPointInTimeRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbClusterToPointInTimeRequest#builder()}
*
*
* @param restoreDbClusterToPointInTimeRequest
* A {@link Consumer} that will call methods on {@link RestoreDBClusterToPointInTimeMessage.Builder} to
* create a request.
* @return Result of the RestoreDBClusterToPointInTime operation returned by the service.
* @throws DbClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InsufficientDbClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBClusterToPointInTime
* @see AWS API Documentation
*/
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(
Consumer restoreDbClusterToPointInTimeRequest)
throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException,
DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException,
InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException,
InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException,
KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException,
DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest.builder()
.applyMutation(restoreDbClusterToPointInTimeRequest).build());
}
/**
*
* 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
.
*
*
*
* @param restoreDbInstanceFromDbSnapshotRequest
* @return Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceFromDBSnapshot
* @see AWS API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbInstanceFromDbSnapshotRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbInstanceFromDbSnapshotRequest#builder()}
*
*
* @param restoreDbInstanceFromDbSnapshotRequest
* A {@link Consumer} that will call methods on {@link RestoreDBInstanceFromDBSnapshotMessage.Builder} to
* create a request.
* @return Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDbSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceFromDBSnapshot
* @see AWS API Documentation
*/
default RestoreDbInstanceFromDbSnapshotResponse restoreDBInstanceFromDBSnapshot(
Consumer restoreDbInstanceFromDbSnapshotRequest)
throws DbInstanceAlreadyExistsException, DbSnapshotNotFoundException, InstanceQuotaExceededException,
InsufficientDbInstanceCapacityException, InvalidDbSnapshotStateException, StorageQuotaExceededException,
InvalidVpcNetworkStateException, InvalidRestoreException, DbSubnetGroupNotFoundException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAzException,
OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException,
KmsKeyNotAccessibleException, DbSecurityGroupNotFoundException, DomainNotFoundException,
DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, RdsException {
return restoreDBInstanceFromDBSnapshot(RestoreDbInstanceFromDbSnapshotRequest.builder()
.applyMutation(restoreDbInstanceFromDbSnapshotRequest).build());
}
/**
*
* 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.
*
*
* @param restoreDbInstanceFromS3Request
* @return Result of the RestoreDBInstanceFromS3 operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws 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.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceFromS3
* @see AWS
* API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbInstanceFromS3Request.Builder} avoiding
* the need to create one manually via {@link RestoreDbInstanceFromS3Request#builder()}
*
*
* @param restoreDbInstanceFromS3Request
* A {@link Consumer} that will call methods on {@link RestoreDBInstanceFromS3Message.Builder} to create a
* request.
* @return Result of the RestoreDBInstanceFromS3 operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws 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.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceFromS3
* @see AWS
* API Documentation
*/
default RestoreDbInstanceFromS3Response restoreDBInstanceFromS3(
Consumer restoreDbInstanceFromS3Request)
throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException,
DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException,
InvalidVpcNetworkStateException, InvalidS3BucketException, ProvisionedIopsNotAvailableInAzException,
OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException,
KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
return restoreDBInstanceFromS3(RestoreDbInstanceFromS3Request.builder().applyMutation(restoreDbInstanceFromS3Request)
.build());
}
/**
*
* 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
.
*
*
*
* @param restoreDbInstanceToPointInTimeRequest
* @return Result of the RestoreDBInstanceToPointInTime operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws PointInTimeRestoreNotEnabledException
* SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceToPointInTime
* @see AWS API Documentation
*/
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 {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbInstanceToPointInTimeRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbInstanceToPointInTimeRequest#builder()}
*
*
* @param restoreDbInstanceToPointInTimeRequest
* A {@link Consumer} that will call methods on {@link RestoreDBInstanceToPointInTimeMessage.Builder} to
* create a request.
* @return Result of the RestoreDBInstanceToPointInTime operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws PointInTimeRestoreNotEnabledException
* SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAzException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DbInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RestoreDBInstanceToPointInTime
* @see AWS API Documentation
*/
default RestoreDbInstanceToPointInTimeResponse restoreDBInstanceToPointInTime(
Consumer 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 {
return restoreDBInstanceToPointInTime(RestoreDbInstanceToPointInTimeRequest.builder()
.applyMutation(restoreDbInstanceToPointInTimeRequest).build());
}
/**
*
* 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).
*
*
* @param revokeDbSecurityGroupIngressRequest
* @return Result of the RevokeDBSecurityGroupIngress operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws 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.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RevokeDBSecurityGroupIngress
* @see AWS API Documentation
*/
default RevokeDbSecurityGroupIngressResponse revokeDBSecurityGroupIngress(
RevokeDbSecurityGroupIngressRequest revokeDbSecurityGroupIngressRequest) throws DbSecurityGroupNotFoundException,
AuthorizationNotFoundException, InvalidDbSecurityGroupStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RevokeDbSecurityGroupIngressRequest.Builder}
* avoiding the need to create one manually via {@link RevokeDbSecurityGroupIngressRequest#builder()}
*
*
* @param revokeDbSecurityGroupIngressRequest
* A {@link Consumer} that will call methods on {@link RevokeDBSecurityGroupIngressMessage.Builder} to create
* a request.
* @return Result of the RevokeDBSecurityGroupIngress operation returned by the service.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws 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.
* @throws InvalidDbSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.RevokeDBSecurityGroupIngress
* @see AWS API Documentation
*/
default RevokeDbSecurityGroupIngressResponse revokeDBSecurityGroupIngress(
Consumer revokeDbSecurityGroupIngressRequest)
throws DbSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidDbSecurityGroupStateException,
AwsServiceException, SdkClientException, RdsException {
return revokeDBSecurityGroupIngress(RevokeDbSecurityGroupIngressRequest.builder()
.applyMutation(revokeDbSecurityGroupIngressRequest).build());
}
/**
*
* Starts a database activity stream to monitor activity on the database. For more information, see Database Activity
* Streams in the Amazon Aurora User Guide.
*
*
* @param startActivityStreamRequest
* @return Result of the StartActivityStream operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartActivityStream
* @see AWS API
* Documentation
*/
default StartActivityStreamResponse startActivityStream(StartActivityStreamRequest startActivityStreamRequest)
throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException,
DbClusterNotFoundException, DbInstanceNotFoundException, KmsKeyNotAccessibleException, AwsServiceException,
SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartActivityStreamRequest.Builder} avoiding the
* need to create one manually via {@link StartActivityStreamRequest#builder()}
*
*
* @param startActivityStreamRequest
* A {@link Consumer} that will call methods on {@link StartActivityStreamRequest.Builder} to create a
* request.
* @return Result of the StartActivityStream operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartActivityStream
* @see AWS API
* Documentation
*/
default StartActivityStreamResponse startActivityStream(
Consumer startActivityStreamRequest) throws InvalidDbInstanceStateException,
InvalidDbClusterStateException, ResourceNotFoundException, DbClusterNotFoundException, DbInstanceNotFoundException,
KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
return startActivityStream(StartActivityStreamRequest.builder().applyMutation(startActivityStreamRequest).build());
}
/**
*
* 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.
*
*
*
* @param startDbClusterRequest
* @return Result of the StartDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartDBCluster
* @see AWS API
* Documentation
*/
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartDbClusterRequest.Builder} avoiding the need to
* create one manually via {@link StartDbClusterRequest#builder()}
*
*
* @param startDbClusterRequest
* A {@link Consumer} that will call methods on {@link StartDBClusterMessage.Builder} to create a request.
* @return Result of the StartDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartDBCluster
* @see AWS API
* Documentation
*/
default StartDbClusterResponse startDBCluster(Consumer startDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
return startDBCluster(StartDbClusterRequest.builder().applyMutation(startDbClusterRequest).build());
}
/**
*
* 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.
*
*
*
* @param startDbInstanceRequest
* @return Result of the StartDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartDBInstance
* @see AWS API
* Documentation
*/
default StartDbInstanceResponse startDBInstance(StartDbInstanceRequest startDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException,
InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, AuthorizationNotFoundException,
KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link StartDbInstanceRequest#builder()}
*
*
* @param startDbInstanceRequest
* A {@link Consumer} that will call methods on {@link StartDBInstanceMessage.Builder} to create a request.
* @return Result of the StartDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InsufficientDbInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVpcNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StartDBInstance
* @see AWS API
* Documentation
*/
default StartDbInstanceResponse startDBInstance(Consumer startDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, InsufficientDbInstanceCapacityException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException,
InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, AuthorizationNotFoundException,
KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, RdsException {
return startDBInstance(StartDbInstanceRequest.builder().applyMutation(startDbInstanceRequest).build());
}
/**
*
* 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.
*
*
* @param stopActivityStreamRequest
* @return Result of the StopActivityStream operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopActivityStream
* @see AWS API
* Documentation
*/
default StopActivityStreamResponse stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest)
throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException,
DbClusterNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopActivityStreamRequest.Builder} avoiding the
* need to create one manually via {@link StopActivityStreamRequest#builder()}
*
*
* @param stopActivityStreamRequest
* A {@link Consumer} that will call methods on {@link StopActivityStreamRequest.Builder} to create a
* request.
* @return Result of the StopActivityStream operation returned by the service.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopActivityStream
* @see AWS API
* Documentation
*/
default StopActivityStreamResponse stopActivityStream(Consumer stopActivityStreamRequest)
throws InvalidDbInstanceStateException, InvalidDbClusterStateException, ResourceNotFoundException,
DbClusterNotFoundException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, RdsException {
return stopActivityStream(StopActivityStreamRequest.builder().applyMutation(stopActivityStreamRequest).build());
}
/**
*
* 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.
*
*
*
* @param stopDbClusterRequest
* @return Result of the StopDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopDBCluster
* @see AWS API
* Documentation
*/
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopDbClusterRequest.Builder} avoiding the need to
* create one manually via {@link StopDbClusterRequest#builder()}
*
*
* @param stopDbClusterRequest
* A {@link Consumer} that will call methods on {@link StopDBClusterMessage.Builder} to create a request.
* @return Result of the StopDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopDBCluster
* @see AWS API
* Documentation
*/
default StopDbClusterResponse stopDBCluster(Consumer stopDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, RdsException {
return stopDBCluster(StopDbClusterRequest.builder().applyMutation(stopDbClusterRequest).build());
}
/**
*
* 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.
*
*
*
* @param stopDbInstanceRequest
* @return Result of the StopDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopDBInstance
* @see AWS API
* Documentation
*/
default StopDbInstanceResponse stopDBInstance(StopDbInstanceRequest stopDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopDbInstanceRequest.Builder} avoiding the need to
* create one manually via {@link StopDbInstanceRequest#builder()}
*
*
* @param stopDbInstanceRequest
* A {@link Consumer} that will call methods on {@link StopDBInstanceMessage.Builder} to create a request.
* @return Result of the StopDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDbInstanceStateException
* The DB instance isn't in a valid state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDbClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws RdsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample RdsClient.StopDBInstance
* @see AWS API
* Documentation
*/
default StopDbInstanceResponse stopDBInstance(Consumer stopDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, RdsException {
return stopDBInstance(StopDbInstanceRequest.builder().applyMutation(stopDbInstanceRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("rds");
}
}