Class AbstractAmazonRDS
- java.lang.Object
-
- com.amazonaws.services.rds.AbstractAmazonRDS
-
- All Implemented Interfaces:
AmazonRDS
- Direct Known Subclasses:
AbstractAmazonRDSAsync
public class AbstractAmazonRDS extends Object implements AmazonRDS
Abstract implementation ofAmazonRDS
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonRDS()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventSubscription
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
Adds a source identifier to an existing RDS event notification subscription.AddTagsToResourceResult
addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to an Amazon RDS resource.ResourcePendingMaintenanceActions
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a DB instance).DBSecurityGroup
authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)
Enables ingress to a DBSecurityGroup using one of two forms of authorization.DBClusterSnapshot
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Creates a snapshot of a DB cluster.DBParameterGroup
copyDBParameterGroup(CopyDBParameterGroupRequest request)
Copies the specified DB parameter group.DBSnapshot
copyDBSnapshot(CopyDBSnapshotRequest request)
Copies the specified DB snapshot.OptionGroup
copyOptionGroup(CopyOptionGroupRequest request)
Copies the specified option group.DBCluster
createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Aurora DB cluster.DBClusterParameterGroup
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
Creates a new DB cluster parameter group.DBClusterSnapshot
createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
Creates a snapshot of a DB cluster.DBInstance
createDBInstance(CreateDBInstanceRequest request)
Creates a new DB instance.DBInstance
createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest request)
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.DBParameterGroup
createDBParameterGroup(CreateDBParameterGroupRequest request)
Creates a new DB parameter group.DBSecurityGroup
createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Creates a new DB security group.DBSnapshot
createDBSnapshot(CreateDBSnapshotRequest request)
Creates a DBSnapshot.DBSubnetGroup
createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Creates a new DB subnet group.EventSubscription
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an RDS event notification subscription.OptionGroup
createOptionGroup(CreateOptionGroupRequest request)
Creates a new option group.DBCluster
deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned DB cluster.DeleteDBClusterParameterGroupResult
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Deletes a specified DB cluster parameter group.DBClusterSnapshot
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
Deletes a DB cluster snapshot.DBInstance
deleteDBInstance(DeleteDBInstanceRequest request)
The DeleteDBInstance action deletes a previously provisioned DB instance.DeleteDBParameterGroupResult
deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DBParameterGroup.DeleteDBSecurityGroupResult
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Deletes a DB security group.DBSnapshot
deleteDBSnapshot(DeleteDBSnapshotRequest request)
Deletes a DBSnapshot.DeleteDBSubnetGroupResult
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Deletes a DB subnet group.EventSubscription
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an RDS event notification subscription.DeleteOptionGroupResult
deleteOptionGroup(DeleteOptionGroupRequest request)
Deletes an existing option group.DescribeAccountAttributesResult
describeAccountAttributes()
Simplified method form for invoking the DescribeAccountAttributes operation.DescribeAccountAttributesResult
describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the attributes for a customer account.DescribeCertificatesResult
describeCertificates()
Simplified method form for invoking the DescribeCertificates operation.DescribeCertificatesResult
describeCertificates(DescribeCertificatesRequest request)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups()
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
Returns a list ofDBClusterParameterGroup
descriptions.DescribeDBClusterParametersResult
describeDBClusterParameters(DescribeDBClusterParametersRequest request)
Returns the detailed parameter list for a particular DB cluster parameter group.DescribeDBClustersResult
describeDBClusters()
Simplified method form for invoking the DescribeDBClusters operation.DescribeDBClustersResult
describeDBClusters(DescribeDBClustersRequest request)
Returns information about provisioned Aurora DB clusters.DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots()
Simplified method form for invoking the DescribeDBClusterSnapshots operation.DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
Returns information about DB cluster snapshots.DescribeDBEngineVersionsResult
describeDBEngineVersions()
Simplified method form for invoking the DescribeDBEngineVersions operation.DescribeDBEngineVersionsResult
describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
Returns a list of the available DB engines.DescribeDBInstancesResult
describeDBInstances()
Simplified method form for invoking the DescribeDBInstances operation.DescribeDBInstancesResult
describeDBInstances(DescribeDBInstancesRequest request)
Returns information about provisioned RDS instances.DescribeDBLogFilesResult
describeDBLogFiles(DescribeDBLogFilesRequest request)
Returns a list of DB log files for the DB instance.DescribeDBParameterGroupsResult
describeDBParameterGroups()
Simplified method form for invoking the DescribeDBParameterGroups operation.DescribeDBParameterGroupsResult
describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
Returns a list ofDBParameterGroup
descriptions.DescribeDBParametersResult
describeDBParameters(DescribeDBParametersRequest request)
Returns the detailed parameter list for a particular DB parameter group.DescribeDBSecurityGroupsResult
describeDBSecurityGroups()
Simplified method form for invoking the DescribeDBSecurityGroups operation.DescribeDBSecurityGroupsResult
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
Returns a list ofDBSecurityGroup
descriptions.DBSnapshotAttributesResult
describeDBSnapshotAttributes()
Simplified method form for invoking the DescribeDBSnapshotAttributes operation.DBSnapshotAttributesResult
describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.DescribeDBSnapshotsResult
describeDBSnapshots()
Simplified method form for invoking the DescribeDBSnapshots operation.DescribeDBSnapshotsResult
describeDBSnapshots(DescribeDBSnapshotsRequest request)
Returns information about DB snapshots.DescribeDBSubnetGroupsResult
describeDBSubnetGroups()
Simplified method form for invoking the DescribeDBSubnetGroups operation.DescribeDBSubnetGroupsResult
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
Returns a list of DBSubnetGroup descriptions.EngineDefaults
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
Returns the default engine and system parameter information for the cluster database engine.EngineDefaults
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Returns the default engine and system parameter information for the specified database engine.DescribeEventCategoriesResult
describeEventCategories()
Simplified method form for invoking the DescribeEventCategories operation.DescribeEventCategoriesResult
describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of categories for all event source types, or, if specified, for a specified source type.DescribeEventsResult
describeEvents()
Simplified method form for invoking the DescribeEvents operation.DescribeEventsResult
describeEvents(DescribeEventsRequest request)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.DescribeEventSubscriptionsResult
describeEventSubscriptions()
Simplified method form for invoking the DescribeEventSubscriptions operation.DescribeEventSubscriptionsResult
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists all the subscription descriptions for a customer account.DescribeOptionGroupOptionsResult
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Describes all available options.DescribeOptionGroupsResult
describeOptionGroups()
Simplified method form for invoking the DescribeOptionGroups operation.DescribeOptionGroupsResult
describeOptionGroups(DescribeOptionGroupsRequest request)
Describes the available option groups.DescribeOrderableDBInstanceOptionsResult
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Returns a list of orderable DB instance options for the specified engine.DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions()
Simplified method form for invoking the DescribePendingMaintenanceActions operation.DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.DescribeReservedDBInstancesResult
describeReservedDBInstances()
Simplified method form for invoking the DescribeReservedDBInstances operation.DescribeReservedDBInstancesResult
describeReservedDBInstances(DescribeReservedDBInstancesRequest request)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings()
Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)
Lists available reserved DB instance offerings.DownloadDBLogFilePortionResult
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Downloads all or a portion of the specified log file, up to 1 MB in size.DBCluster
failoverDBCluster()
Simplified method form for invoking the FailoverDBCluster operation.DBCluster
failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.ListTagsForResourceResult
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on an Amazon RDS resource.DBCluster
modifyDBCluster(ModifyDBClusterRequest request)
Modify a setting for an Amazon Aurora DB cluster.ModifyDBClusterParameterGroupResult
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group.DBInstance
modifyDBInstance(ModifyDBInstanceRequest request)
Modify settings for a DB instance.ModifyDBParameterGroupResult
modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group.DBSnapshotAttributesResult
modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.DBSubnetGroup
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
Modifies an existing DB subnet group.EventSubscription
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing RDS event notification subscription.OptionGroup
modifyOptionGroup(ModifyOptionGroupRequest request)
Modifies an existing option group.DBInstance
promoteReadReplica(PromoteReadReplicaRequest request)
Promotes a Read Replica DB instance to a standalone DB instance.ReservedDBInstance
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
Purchases a reserved DB instance offering.DBInstance
rebootDBInstance(RebootDBInstanceRequest request)
Rebooting a DB instance restarts the database engine service.EventSubscription
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
Removes a source identifier from an existing RDS event notification subscription.RemoveTagsFromResourceResult
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from an Amazon RDS resource.ResetDBClusterParameterGroupResult
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group to the default value.ResetDBParameterGroupResult
resetDBParameterGroup(ResetDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group to the engine/system default value.DBCluster
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB cluster snapshot.DBCluster
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Restores a DB cluster to an arbitrary point in time.DBInstance
restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)
Creates a new DB instance from a DB snapshot.DBInstance
restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)
Restores a DB instance to an arbitrary point in time.DBSecurityGroup
revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("rds.amazonaws.com").void
setRegion(Region region)
An alternative toAmazonRDS.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonRDS
Overrides the default endpoint for this client ("rds.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex: "rds.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonRDS
- Parameters:
endpoint
- The endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex: "rds.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
public void setRegion(Region region)
Description copied from interface:AmazonRDS
An alternative toAmazonRDS.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonRDS
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
addSourceIdentifierToSubscription
public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
Description copied from interface:AmazonRDS
Adds a source identifier to an existing RDS event notification subscription.
- Specified by:
addSourceIdentifierToSubscription
in interfaceAmazonRDS
- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
-
addTagsToResource
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
addTagsToResource
in interfaceAmazonRDS
- Returns:
- Result of the AddTagsToResource operation returned by the service.
-
applyPendingMaintenanceAction
public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Description copied from interface:AmazonRDS
Applies a pending maintenance action to a resource (for example, to a DB instance).
- Specified by:
applyPendingMaintenanceAction
in interfaceAmazonRDS
- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
-
authorizeDBSecurityGroupIngress
public DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)
Description copied from interface:AmazonRDS
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 cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot 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.
- Specified by:
authorizeDBSecurityGroupIngress
in interfaceAmazonRDS
- Returns:
- Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
-
copyDBClusterSnapshot
public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Description copied from interface:AmazonRDS
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
copyDBClusterSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
-
copyDBParameterGroup
public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)
Description copied from interface:AmazonRDS
Copies the specified DB parameter group.
- Specified by:
copyDBParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
-
copyDBSnapshot
public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest request)
Description copied from interface:AmazonRDS
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Specified by:
copyDBSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the CopyDBSnapshot operation returned by the service.
-
copyOptionGroup
public OptionGroup copyOptionGroup(CopyOptionGroupRequest request)
Description copied from interface:AmazonRDS
Copies the specified option group.
- Specified by:
copyOptionGroup
in interfaceAmazonRDS
- Returns:
- Result of the CopyOptionGroup operation returned by the service.
-
createDBCluster
public DBCluster createDBCluster(CreateDBClusterRequest request)
Description copied from interface:AmazonRDS
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBCluster
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBCluster operation returned by the service.
-
createDBClusterParameterGroup
public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
Description copied from interface:AmazonRDS
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 command to verify that your DB cluster parameter group has been created or modified.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBClusterParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
-
createDBClusterSnapshot
public DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
Description copied from interface:AmazonRDS
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBClusterSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
-
createDBInstance
public DBInstance createDBInstance(CreateDBInstanceRequest request)
Description copied from interface:AmazonRDS
Creates a new DB instance.
- Specified by:
createDBInstance
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBInstance operation returned by the service.
-
createDBInstanceReadReplica
public DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest request)
Description copied from interface:AmazonRDS
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments 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 below.
The source DB instance must have backup retention enabled.
- Specified by:
createDBInstanceReadReplica
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBInstanceReadReplica operation returned by the service.
-
createDBParameterGroup
public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest request)
Description copied from interface:AmazonRDS
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.- Specified by:
createDBParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
-
createDBSecurityGroup
public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Description copied from interface:AmazonRDS
Creates a new DB security group. DB security groups control access to a DB instance.
- Specified by:
createDBSecurityGroup
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBSecurityGroup operation returned by the service.
-
createDBSnapshot
public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest request)
Description copied from interface:AmazonRDS
Creates a DBSnapshot. The source DBInstance must be in "available" state.
- Specified by:
createDBSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBSnapshot operation returned by the service.
-
createDBSubnetGroup
public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Description copied from interface:AmazonRDS
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Specified by:
createDBSubnetGroup
in interfaceAmazonRDS
- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
-
createEventSubscription
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
Description copied from interface:AmazonRDS
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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will 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 will be notified of events generated from all RDS sources belonging to your customer account.
- Specified by:
createEventSubscription
in interfaceAmazonRDS
- Returns:
- Result of the CreateEventSubscription operation returned by the service.
-
createOptionGroup
public OptionGroup createOptionGroup(CreateOptionGroupRequest request)
Description copied from interface:AmazonRDS
Creates a new option group. You can create up to 20 option groups.
- Specified by:
createOptionGroup
in interfaceAmazonRDS
- Returns:
- Result of the CreateOptionGroup operation returned by the service.
-
deleteDBCluster
public DBCluster deleteDBCluster(DeleteDBClusterRequest request)
Description copied from interface:AmazonRDS
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBCluster
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBCluster operation returned by the service.
-
deleteDBClusterParameterGroup
public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Description copied from interface:AmazonRDS
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBClusterParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
-
deleteDBClusterSnapshot
public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
Description copied from interface:AmazonRDS
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 Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBClusterSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
-
deleteDBInstance
public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
Description copied from interface:AmazonRDS
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this operation. The action cannot 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', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
- Specified by:
deleteDBInstance
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBInstance operation returned by the service.
-
deleteDBParameterGroup
public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Description copied from interface:AmazonRDS
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
- Specified by:
deleteDBParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
-
deleteDBSecurityGroup
public DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Description copied from interface:AmazonRDS
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances. - Specified by:
deleteDBSecurityGroup
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBSecurityGroup operation returned by the service.
-
deleteDBSnapshot
public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest request)
Description copied from interface:AmazonRDS
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available
state to be deleted.- Specified by:
deleteDBSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBSnapshot operation returned by the service.
-
deleteDBSubnetGroup
public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Description copied from interface:AmazonRDS
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances. - Specified by:
deleteDBSubnetGroup
in interfaceAmazonRDS
- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
-
deleteEventSubscription
public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest request)
Description copied from interface:AmazonRDS
Deletes an RDS event notification subscription.
- Specified by:
deleteEventSubscription
in interfaceAmazonRDS
- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
-
deleteOptionGroup
public DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest request)
Description copied from interface:AmazonRDS
Deletes an existing option group.
- Specified by:
deleteOptionGroup
in interfaceAmazonRDS
- Returns:
- Result of the DeleteOptionGroup operation returned by the service.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Description copied from interface:AmazonRDS
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 does not take any parameters.
- Specified by:
describeAccountAttributes
in interfaceAmazonRDS
- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeAccountAttributes operation.- Specified by:
describeAccountAttributes
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeAccountAttributes(DescribeAccountAttributesRequest)
-
describeCertificates
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
Description copied from interface:AmazonRDS
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
- Specified by:
describeCertificates
in interfaceAmazonRDS
- Returns:
- Result of the DescribeCertificates operation returned by the service.
-
describeCertificates
public DescribeCertificatesResult describeCertificates()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeCertificates operation.- Specified by:
describeCertificates
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeCertificates(DescribeCertificatesRequest)
-
describeDBClusterParameterGroups
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
Description copied from interface:AmazonRDS
Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterParameterGroups
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
-
describeDBClusterParameterGroups
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.- Specified by:
describeDBClusterParameterGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)
-
describeDBClusterParameters
public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)
Description copied from interface:AmazonRDS
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterParameters
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
-
describeDBClusterSnapshots
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
Description copied from interface:AmazonRDS
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterSnapshots
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
-
describeDBClusterSnapshots
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusterSnapshots operation.- Specified by:
describeDBClusterSnapshots
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)
-
describeDBClusters
public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)
Description copied from interface:AmazonRDS
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusters
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBClusters operation returned by the service.
-
describeDBClusters
public DescribeDBClustersResult describeDBClusters()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusters operation.- Specified by:
describeDBClusters
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusters(DescribeDBClustersRequest)
-
describeDBEngineVersions
public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
Description copied from interface:AmazonRDS
Returns a list of the available DB engines.
- Specified by:
describeDBEngineVersions
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
-
describeDBEngineVersions
public DescribeDBEngineVersionsResult describeDBEngineVersions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBEngineVersions operation.- Specified by:
describeDBEngineVersions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest)
-
describeDBInstances
public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
Description copied from interface:AmazonRDS
Returns information about provisioned RDS instances. This API supports pagination.
- Specified by:
describeDBInstances
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
-
describeDBInstances
public DescribeDBInstancesResult describeDBInstances()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBInstances operation.- Specified by:
describeDBInstances
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBInstances(DescribeDBInstancesRequest)
-
describeDBLogFiles
public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest request)
Description copied from interface:AmazonRDS
Returns a list of DB log files for the DB instance.
- Specified by:
describeDBLogFiles
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBLogFiles operation returned by the service.
-
describeDBParameterGroups
public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
Description copied from interface:AmazonRDS
Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Specified by:
describeDBParameterGroups
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
-
describeDBParameterGroups
public DescribeDBParameterGroupsResult describeDBParameterGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBParameterGroups operation.- Specified by:
describeDBParameterGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBParameterGroups(DescribeDBParameterGroupsRequest)
-
describeDBParameters
public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest request)
Description copied from interface:AmazonRDS
Returns the detailed parameter list for a particular DB parameter group.
- Specified by:
describeDBParameters
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBParameters operation returned by the service.
-
describeDBSecurityGroups
public DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
Description copied from interface:AmazonRDS
Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.- Specified by:
describeDBSecurityGroups
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBSecurityGroups operation returned by the service.
-
describeDBSecurityGroups
public DescribeDBSecurityGroupsResult describeDBSecurityGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSecurityGroups operation.- Specified by:
describeDBSecurityGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)
-
describeDBSnapshotAttributes
public DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)
Description copied from interface:AmazonRDS
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns therestore
attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB snapshot is public and can be copied or restored by all 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.
- Specified by:
describeDBSnapshotAttributes
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBSnapshotAttributes operation returned by the service.
-
describeDBSnapshotAttributes
public DBSnapshotAttributesResult describeDBSnapshotAttributes()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSnapshotAttributes operation.- Specified by:
describeDBSnapshotAttributes
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)
-
describeDBSnapshots
public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest request)
Description copied from interface:AmazonRDS
Returns information about DB snapshots. This API supports pagination.
- Specified by:
describeDBSnapshots
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBSnapshots operation returned by the service.
-
describeDBSnapshots
public DescribeDBSnapshotsResult describeDBSnapshots()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSnapshots operation.- Specified by:
describeDBSnapshots
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest)
-
describeDBSubnetGroups
public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
describeDBSubnetGroups
in interfaceAmazonRDS
- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
-
describeDBSubnetGroups
public DescribeDBSubnetGroupsResult describeDBSubnetGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSubnetGroups operation.- Specified by:
describeDBSubnetGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSubnetGroups(DescribeDBSubnetGroupsRequest)
-
describeEngineDefaultClusterParameters
public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
Description copied from interface:AmazonRDS
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeEngineDefaultClusterParameters
in interfaceAmazonRDS
- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
-
describeEngineDefaultParameters
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Description copied from interface:AmazonRDS
Returns the default engine and system parameter information for the specified database engine.
- Specified by:
describeEngineDefaultParameters
in interfaceAmazonRDS
- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
-
describeEventCategories
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
describeEventCategories
in interfaceAmazonRDS
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
-
describeEventCategories
public DescribeEventCategoriesResult describeEventCategories()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEventCategories operation.- Specified by:
describeEventCategories
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEventCategories(DescribeEventCategoriesRequest)
-
describeEventSubscriptions
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
describeEventSubscriptions
in interfaceAmazonRDS
- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
-
describeEventSubscriptions
public DescribeEventSubscriptionsResult describeEventSubscriptions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEventSubscriptions operation.- Specified by:
describeEventSubscriptions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEventSubscriptions(DescribeEventSubscriptionsRequest)
-
describeEvents
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
describeEvents
in interfaceAmazonRDS
- Returns:
- Result of the DescribeEvents operation returned by the service.
-
describeEvents
public DescribeEventsResult describeEvents()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEvents operation.- Specified by:
describeEvents
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEvents(DescribeEventsRequest)
-
describeOptionGroupOptions
public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Description copied from interface:AmazonRDS
Describes all available options.
- Specified by:
describeOptionGroupOptions
in interfaceAmazonRDS
- Returns:
- Result of the DescribeOptionGroupOptions operation returned by the service.
-
describeOptionGroups
public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest request)
Description copied from interface:AmazonRDS
Describes the available option groups.
- Specified by:
describeOptionGroups
in interfaceAmazonRDS
- Returns:
- Result of the DescribeOptionGroups operation returned by the service.
-
describeOptionGroups
public DescribeOptionGroupsResult describeOptionGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeOptionGroups operation.- Specified by:
describeOptionGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeOptionGroups(DescribeOptionGroupsRequest)
-
describeOrderableDBInstanceOptions
public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Description copied from interface:AmazonRDS
Returns a list of orderable DB instance options for the specified engine.
- Specified by:
describeOrderableDBInstanceOptions
in interfaceAmazonRDS
- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
-
describePendingMaintenanceActions
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
Description copied from interface:AmazonRDS
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Specified by:
describePendingMaintenanceActions
in interfaceAmazonRDS
- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
-
describePendingMaintenanceActions
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribePendingMaintenanceActions operation.- Specified by:
describePendingMaintenanceActions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
-
describeReservedDBInstances
public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest request)
Description copied from interface:AmazonRDS
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Specified by:
describeReservedDBInstances
in interfaceAmazonRDS
- Returns:
- Result of the DescribeReservedDBInstances operation returned by the service.
-
describeReservedDBInstances
public DescribeReservedDBInstancesResult describeReservedDBInstances()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeReservedDBInstances operation.- Specified by:
describeReservedDBInstances
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeReservedDBInstances(DescribeReservedDBInstancesRequest)
-
describeReservedDBInstancesOfferings
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)
Description copied from interface:AmazonRDS
Lists available reserved DB instance offerings.
- Specified by:
describeReservedDBInstancesOfferings
in interfaceAmazonRDS
- Returns:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
-
describeReservedDBInstancesOfferings
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.- Specified by:
describeReservedDBInstancesOfferings
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)
-
downloadDBLogFilePortion
public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Description copied from interface:AmazonRDS
Downloads all or a portion of the specified log file, up to 1 MB in size.
- Specified by:
downloadDBLogFilePortion
in interfaceAmazonRDS
- Returns:
- Result of the DownloadDBLogFilePortion operation returned by the service.
-
failoverDBCluster
public DBCluster failoverDBCluster(FailoverDBClusterRequest request)
Description copied from interface:AmazonRDS
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
failoverDBCluster
in interfaceAmazonRDS
- Returns:
- Result of the FailoverDBCluster operation returned by the service.
-
failoverDBCluster
public DBCluster failoverDBCluster()
Description copied from interface:AmazonRDS
Simplified method form for invoking the FailoverDBCluster operation.- Specified by:
failoverDBCluster
in interfaceAmazonRDS
- See Also:
AmazonRDS.failoverDBCluster(FailoverDBClusterRequest)
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Description copied from interface:AmazonRDS
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Specified by:
listTagsForResource
in interfaceAmazonRDS
- Returns:
- Result of the ListTagsForResource operation returned by the service.
-
modifyDBCluster
public DBCluster modifyDBCluster(ModifyDBClusterRequest request)
Description copied from interface:AmazonRDS
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 Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
modifyDBCluster
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBCluster operation returned by the service.
-
modifyDBClusterParameterGroup
public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
Description copied from interface:AmazonRDS
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS 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 command to verify that your DB cluster parameter group has been created or modified.- Specified by:
modifyDBClusterParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
-
modifyDBInstance
public DBInstance modifyDBInstance(ModifyDBInstanceRequest request)
Description copied from interface:AmazonRDS
Modify 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.
- Specified by:
modifyDBInstance
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBInstance operation returned by the service.
-
modifyDBParameterGroup
public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
Description copied from interface:AmazonRDS
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.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.- Specified by:
modifyDBParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
-
modifyDBSnapshotAttribute
public DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)
Description copied from interface:AmazonRDS
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 theAttributeName
and use theValuesToAdd
parameter to add a list of the AWS account ids that are authorized to restore the manual DB snapshot. Uses the valueall
to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add theall
value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.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.
If the manual DB snapshot is encrypted, it cannot be shared.
- Specified by:
modifyDBSnapshotAttribute
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBSnapshotAttribute operation returned by the service.
-
modifyDBSubnetGroup
public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
Description copied from interface:AmazonRDS
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Specified by:
modifyDBSubnetGroup
in interfaceAmazonRDS
- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
-
modifyEventSubscription
public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
Description copied from interface:AmazonRDS
Modifies an existing RDS event notification subscription. Note that you cannot 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.
- Specified by:
modifyEventSubscription
in interfaceAmazonRDS
- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
-
modifyOptionGroup
public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest request)
Description copied from interface:AmazonRDS
Modifies an existing option group.
- Specified by:
modifyOptionGroup
in interfaceAmazonRDS
- Returns:
- Result of the ModifyOptionGroup operation returned by the service.
-
promoteReadReplica
public DBInstance promoteReadReplica(PromoteReadReplicaRequest request)
Description copied from interface:AmazonRDS
Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
- Specified by:
promoteReadReplica
in interfaceAmazonRDS
- Returns:
- Result of the PromoteReadReplica operation returned by the service.
-
purchaseReservedDBInstancesOffering
public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
Description copied from interface:AmazonRDS
Purchases a reserved DB instance offering.
- Specified by:
purchaseReservedDBInstancesOffering
in interfaceAmazonRDS
- Returns:
- Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
-
rebootDBInstance
public DBInstance rebootDBInstance(RebootDBInstanceRequest request)
Description copied from interface:AmazonRDS
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
- Specified by:
rebootDBInstance
in interfaceAmazonRDS
- Returns:
- Result of the RebootDBInstance operation returned by the service.
-
removeSourceIdentifierFromSubscription
public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
Description copied from interface:AmazonRDS
Removes a source identifier from an existing RDS event notification subscription.
- Specified by:
removeSourceIdentifierFromSubscription
in interfaceAmazonRDS
- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
-
removeTagsFromResource
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Description copied from interface:AmazonRDS
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Specified by:
removeTagsFromResource
in interfaceAmazonRDS
- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
-
resetDBClusterParameterGroup
public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
Description copied from interface:AmazonRDS
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
parameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
resetDBClusterParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
-
resetDBParameterGroup
public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest request)
Description copied from interface:AmazonRDS
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Specified by:
resetDBParameterGroup
in interfaceAmazonRDS
- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
-
restoreDBClusterFromSnapshot
public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Description copied from interface:AmazonRDS
Creates a new DB cluster from a DB cluster snapshot. 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
restoreDBClusterFromSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
-
restoreDBClusterToPointInTime
public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Description copied from interface:AmazonRDS
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
restoreDBClusterToPointInTime
in interfaceAmazonRDS
- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
-
restoreDBInstanceFromDBSnapshot
public DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)
Description copied from interface:AmazonRDS
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 does not 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.- Specified by:
restoreDBInstanceFromDBSnapshot
in interfaceAmazonRDS
- Returns:
- Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
-
restoreDBInstanceToPointInTime
public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)
Description copied from interface:AmazonRDS
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.
- Specified by:
restoreDBInstanceToPointInTime
in interfaceAmazonRDS
- Returns:
- Result of the RestoreDBInstanceToPointInTime operation returned by the service.
-
revokeDBSecurityGroupIngress
public DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)
Description copied from interface:AmazonRDS
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).
- Specified by:
revokeDBSecurityGroupIngress
in interfaceAmazonRDS
- Returns:
- Result of the RevokeDBSecurityGroupIngress operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AmazonRDS
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonRDS
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonRDS
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-