@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonRDS extends Object implements AmazonRDS
AmazonRDS. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AddRoleToDBClusterResult |
addRoleToDBCluster(AddRoleToDBClusterRequest request)
Associates an Identity and Access Management (IAM) role from an Aurora DB cluster.
|
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.
|
DBClusterParameterGroup |
copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
Copies the specified DB cluster parameter group.
|
DBClusterSnapshot |
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Copies 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 new DB instance that acts as a Read Replica for an existing 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 of
DBClusterParameterGroup 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.
|
DBClusterSnapshotAttributesResult |
describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
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 of
DBParameterGroup 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 of
DBSecurityGroup 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.
|
DescribeSourceRegionsResult |
describeSourceRegions(DescribeSourceRegionsRequest request)
Returns a list of the source AWS regions where the current AWS Region can create a Read Replica or copy a DB
snapshot from.
|
ValidDBInstanceModificationsMessage |
describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB
instance.
|
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.
|
DBClusterSnapshotAttributesResult |
modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
DBInstance |
modifyDBInstance(ModifyDBInstanceRequest request)
Modifies settings for a DB instance.
|
ModifyDBParameterGroupResult |
modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group.
|
DBSnapshot |
modifyDBSnapshot(ModifyDBSnapshotRequest request)
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
|
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.
|
DBCluster |
promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
Promotes a Read Replica DB cluster to a standalone DB cluster.
|
ReservedDBInstance |
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
Purchases a reserved DB instance offering.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest request)
Rebooting a DB instance restarts the database engine service.
|
RemoveRoleFromDBClusterResult |
removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster.
|
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 |
restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket.
|
DBCluster |
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or 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 to
AmazonRDS.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.
|
DBInstance |
startDBInstance(StartDBInstanceRequest request)
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the
StopDBInstance action.
|
DBInstance |
stopDBInstance(StopDBInstanceRequest request)
Stops a DB instance.
|
AmazonRDSWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonRDS
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.
setEndpoint in interface AmazonRDSendpoint - 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.public void setRegion(Region region)
AmazonRDSAmazonRDS.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.
setRegion in interface AmazonRDSregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AddRoleToDBClusterResult addRoleToDBCluster(AddRoleToDBClusterRequest request)
AmazonRDSAssociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
addRoleToDBCluster in interface AmazonRDSpublic EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
AmazonRDSAdds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscription in interface AmazonRDSpublic AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AmazonRDSAdds 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.
addTagsToResource in interface AmazonRDSpublic ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
AmazonRDSApplies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceAction in interface AmazonRDSpublic DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)
AmazonRDSEnables 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 AWS 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.
authorizeDBSecurityGroupIngress in interface AmazonRDSpublic DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
AmazonRDSCopies the specified DB cluster parameter group.
copyDBClusterParameterGroup in interface AmazonRDSpublic DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
AmazonRDSCopies 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 (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 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 DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
copyDBClusterSnapshot in interface AmazonRDSpublic DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)
AmazonRDSCopies the specified DB parameter group.
copyDBParameterGroup in interface AmazonRDSpublic DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest request)
AmazonRDSCopies 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.
You cannot copy an encrypted, shared DB snapshot from one AWS Region to another.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
copyDBSnapshot in interface AmazonRDSpublic OptionGroup copyOptionGroup(CopyOptionGroupRequest request)
AmazonRDSCopies the specified option group.
copyOptionGroup in interface AmazonRDSpublic DBCluster createDBCluster(CreateDBClusterRequest request)
AmazonRDSCreates 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBCluster in interface AmazonRDSpublic DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
AmazonRDSCreates 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.
createDBClusterParameterGroup in interface AmazonRDSpublic DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
AmazonRDSCreates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterSnapshot in interface AmazonRDSpublic DBInstance createDBInstance(CreateDBInstanceRequest request)
AmazonRDSCreates a new DB instance.
createDBInstance in interface AmazonRDSpublic DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest request)
AmazonRDSCreates 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, or PostgreSQL.
Amazon Aurora does not 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 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.
For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.
createDBInstanceReadReplica in interface AmazonRDSpublic DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest request)
AmazonRDSCreates 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.
createDBParameterGroup in interface AmazonRDSpublic DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest request)
AmazonRDSCreates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroup in interface AmazonRDSpublic DBSnapshot createDBSnapshot(CreateDBSnapshotRequest request)
AmazonRDSCreates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshot in interface AmazonRDSpublic DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)
AmazonRDSCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
createDBSubnetGroup in interface AmazonRDSpublic EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
AmazonRDSCreates 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.
createEventSubscription in interface AmazonRDSpublic OptionGroup createOptionGroup(CreateOptionGroupRequest request)
AmazonRDSCreates a new option group. You can create up to 20 option groups.
createOptionGroup in interface AmazonRDSpublic DBCluster deleteDBCluster(DeleteDBClusterRequest request)
AmazonRDSThe DeleteDBCluster action deletes a previously provisioned DB cluster. 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 specified DB cluster are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBCluster in interface AmazonRDSpublic DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
AmazonRDSDeletes 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.
deleteDBClusterParameterGroup in interface AmazonRDSpublic DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
AmazonRDSDeletes 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.
deleteDBClusterSnapshot in interface AmazonRDSpublic DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
AmazonRDS
The DeleteDBInstance action deletes a previously provisioned DB instance. 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 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 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, you can only delete it when the
SkipFinalSnapshot parameter is set to true.
If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot 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.
deleteDBInstance in interface AmazonRDSpublic DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
AmazonRDSDeletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
deleteDBParameterGroup in interface AmazonRDSpublic DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
AmazonRDSDeletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroup in interface AmazonRDSpublic DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest request)
AmazonRDSDeletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available state to be deleted.
deleteDBSnapshot in interface AmazonRDSpublic DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
AmazonRDSDeletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroup in interface AmazonRDSpublic EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest request)
AmazonRDSDeletes an RDS event notification subscription.
deleteEventSubscription in interface AmazonRDSpublic DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest request)
AmazonRDSDeletes an existing option group.
deleteOptionGroup in interface AmazonRDSpublic DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
AmazonRDSLists 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.
describeAccountAttributes in interface AmazonRDSpublic DescribeAccountAttributesResult describeAccountAttributes()
AmazonRDSdescribeAccountAttributes in interface AmazonRDSAmazonRDS.describeAccountAttributes(DescribeAccountAttributesRequest)public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
AmazonRDSLists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificates in interface AmazonRDSpublic DescribeCertificatesResult describeCertificates()
AmazonRDSdescribeCertificates in interface AmazonRDSAmazonRDS.describeCertificates(DescribeCertificatesRequest)public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
AmazonRDS
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 Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParameterGroups in interface AmazonRDSpublic DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()
AmazonRDSdescribeDBClusterParameterGroups in interface AmazonRDSAmazonRDS.describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)
AmazonRDSReturns 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.
describeDBClusterParameters in interface AmazonRDSpublic DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
AmazonRDSReturns 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.
describeDBClusterSnapshotAttributes in interface AmazonRDSpublic DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
AmazonRDSReturns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterSnapshots in interface AmazonRDSpublic DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()
AmazonRDSdescribeDBClusterSnapshots in interface AmazonRDSAmazonRDS.describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)
AmazonRDSReturns 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.
describeDBClusters in interface AmazonRDSpublic DescribeDBClustersResult describeDBClusters()
AmazonRDSdescribeDBClusters in interface AmazonRDSAmazonRDS.describeDBClusters(DescribeDBClustersRequest)public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
AmazonRDSReturns a list of the available DB engines.
describeDBEngineVersions in interface AmazonRDSpublic DescribeDBEngineVersionsResult describeDBEngineVersions()
AmazonRDSdescribeDBEngineVersions in interface AmazonRDSAmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest)public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
AmazonRDSReturns information about provisioned RDS instances. This API supports pagination.
describeDBInstances in interface AmazonRDSpublic DescribeDBInstancesResult describeDBInstances()
AmazonRDSdescribeDBInstances in interface AmazonRDSAmazonRDS.describeDBInstances(DescribeDBInstancesRequest)public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest request)
AmazonRDSReturns a list of DB log files for the DB instance.
describeDBLogFiles in interface AmazonRDSpublic DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
AmazonRDS
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroups in interface AmazonRDSpublic DescribeDBParameterGroupsResult describeDBParameterGroups()
AmazonRDSdescribeDBParameterGroups in interface AmazonRDSAmazonRDS.describeDBParameterGroups(DescribeDBParameterGroupsRequest)public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest request)
AmazonRDSReturns the detailed parameter list for a particular DB parameter group.
describeDBParameters in interface AmazonRDSpublic DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
AmazonRDS
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSecurityGroups in interface AmazonRDSpublic DescribeDBSecurityGroupsResult describeDBSecurityGroups()
AmazonRDSdescribeDBSecurityGroups in interface AmazonRDSAmazonRDS.describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)public DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)
AmazonRDSReturns 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.
describeDBSnapshotAttributes in interface AmazonRDSpublic DBSnapshotAttributesResult describeDBSnapshotAttributes()
AmazonRDSdescribeDBSnapshotAttributes in interface AmazonRDSAmazonRDS.describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest request)
AmazonRDSReturns information about DB snapshots. This API action supports pagination.
describeDBSnapshots in interface AmazonRDSpublic DescribeDBSnapshotsResult describeDBSnapshots()
AmazonRDSdescribeDBSnapshots in interface AmazonRDSAmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest)public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
AmazonRDSReturns 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.
describeDBSubnetGroups in interface AmazonRDSpublic DescribeDBSubnetGroupsResult describeDBSubnetGroups()
AmazonRDSdescribeDBSubnetGroups in interface AmazonRDSAmazonRDS.describeDBSubnetGroups(DescribeDBSubnetGroupsRequest)public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
AmazonRDSReturns 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.
describeEngineDefaultClusterParameters in interface AmazonRDSpublic EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
AmazonRDSReturns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParameters in interface AmazonRDSpublic DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
AmazonRDSDisplays 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.
describeEventCategories in interface AmazonRDSpublic DescribeEventCategoriesResult describeEventCategories()
AmazonRDSdescribeEventCategories in interface AmazonRDSAmazonRDS.describeEventCategories(DescribeEventCategoriesRequest)public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
AmazonRDSLists 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.
describeEventSubscriptions in interface AmazonRDSpublic DescribeEventSubscriptionsResult describeEventSubscriptions()
AmazonRDSdescribeEventSubscriptions in interface AmazonRDSAmazonRDS.describeEventSubscriptions(DescribeEventSubscriptionsRequest)public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AmazonRDSReturns 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.
describeEvents in interface AmazonRDSpublic DescribeEventsResult describeEvents()
AmazonRDSdescribeEvents in interface AmazonRDSAmazonRDS.describeEvents(DescribeEventsRequest)public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
AmazonRDSDescribes all available options.
describeOptionGroupOptions in interface AmazonRDSpublic DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest request)
AmazonRDSDescribes the available option groups.
describeOptionGroups in interface AmazonRDSpublic DescribeOptionGroupsResult describeOptionGroups()
AmazonRDSdescribeOptionGroups in interface AmazonRDSAmazonRDS.describeOptionGroups(DescribeOptionGroupsRequest)public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
AmazonRDSReturns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptions in interface AmazonRDSpublic DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
AmazonRDSReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActions in interface AmazonRDSpublic DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()
AmazonRDSdescribePendingMaintenanceActions in interface AmazonRDSAmazonRDS.describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest request)
AmazonRDSReturns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstances in interface AmazonRDSpublic DescribeReservedDBInstancesResult describeReservedDBInstances()
AmazonRDSdescribeReservedDBInstances in interface AmazonRDSAmazonRDS.describeReservedDBInstances(DescribeReservedDBInstancesRequest)public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)
AmazonRDSLists available reserved DB instance offerings.
describeReservedDBInstancesOfferings in interface AmazonRDSpublic DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
AmazonRDSdescribeReservedDBInstancesOfferings in interface AmazonRDSAmazonRDS.describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)public DescribeSourceRegionsResult describeSourceRegions(DescribeSourceRegionsRequest request)
AmazonRDSReturns 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.
describeSourceRegions in interface AmazonRDSpublic ValidDBInstanceModificationsMessage describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
AmazonRDSYou can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
describeValidDBInstanceModifications in interface AmazonRDSpublic DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
AmazonRDSDownloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortion in interface AmazonRDSpublic DBCluster failoverDBCluster(FailoverDBClusterRequest request)
AmazonRDSForces 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
failoverDBCluster in interface AmazonRDSpublic DBCluster failoverDBCluster()
AmazonRDSfailoverDBCluster in interface AmazonRDSAmazonRDS.failoverDBCluster(FailoverDBClusterRequest)public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonRDSLists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
listTagsForResource in interface AmazonRDSpublic DBCluster modifyDBCluster(ModifyDBClusterRequest request)
AmazonRDSModify 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.
modifyDBCluster in interface AmazonRDSpublic ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
AmazonRDS
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 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.
modifyDBClusterParameterGroup in interface AmazonRDSpublic DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
AmazonRDSAdds 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.
modifyDBClusterSnapshotAttribute in interface AmazonRDSpublic DBInstance modifyDBInstance(ModifyDBInstanceRequest request)
AmazonRDSModifies 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.
modifyDBInstance in interface AmazonRDSpublic ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
AmazonRDS
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.
modifyDBParameterGroup in interface AmazonRDSpublic DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest request)
AmazonRDSUpdates 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.
modifyDBSnapshot in interface AmazonRDSpublic DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)
AmazonRDSAdds 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.
modifyDBSnapshotAttribute in interface AmazonRDSpublic DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
AmazonRDSModifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
modifyDBSubnetGroup in interface AmazonRDSpublic EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
AmazonRDSModifies 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.
modifyEventSubscription in interface AmazonRDSpublic OptionGroup modifyOptionGroup(ModifyOptionGroupRequest request)
AmazonRDSModifies an existing option group.
modifyOptionGroup in interface AmazonRDSpublic DBInstance promoteReadReplica(PromoteReadReplicaRequest request)
AmazonRDSPromotes 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.
promoteReadReplica in interface AmazonRDSpublic DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
AmazonRDSPromotes a Read Replica DB cluster to a standalone DB cluster.
promoteReadReplicaDBCluster in interface AmazonRDSpublic ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
AmazonRDSPurchases a reserved DB instance offering.
purchaseReservedDBInstancesOffering in interface AmazonRDSpublic DBInstance rebootDBInstance(RebootDBInstanceRequest request)
AmazonRDSRebooting 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 is 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.
rebootDBInstance in interface AmazonRDSpublic RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
AmazonRDSDisassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
removeRoleFromDBCluster in interface AmazonRDSpublic EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
AmazonRDSRemoves a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscription in interface AmazonRDSpublic RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AmazonRDSRemoves metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
removeTagsFromResource in interface AmazonRDSpublic ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
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 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
resetDBClusterParameterGroup in interface AmazonRDSpublic ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest request)
AmazonRDS
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.
resetDBParameterGroup in interface AmazonRDSpublic DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)
AmazonRDSCreates 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 from MySQL by Using an Amazon S3 Bucket.
restoreDBClusterFromS3 in interface AmazonRDSpublic DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
AmazonRDSCreates 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterFromSnapshot in interface AmazonRDSpublic DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
AmazonRDS
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 Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterToPointInTime in interface AmazonRDSpublic DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)
AmazonRDSCreates 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.
restoreDBInstanceFromDBSnapshot in interface AmazonRDSpublic DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)
AmazonRDSRestores 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.
restoreDBInstanceToPointInTime in interface AmazonRDSpublic DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)
AmazonRDSRevokes 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).
revokeDBSecurityGroupIngress in interface AmazonRDSpublic DBInstance startDBInstance(StartDBInstanceRequest request)
AmazonRDSStarts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.
startDBInstance in interface AmazonRDSpublic DBInstance stopDBInstance(StopDBInstanceRequest request)
AmazonRDSStops a 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 and Starting a DB instance in the AWS RDS user guide.
stopDBInstance in interface AmazonRDSpublic void shutdown()
AmazonRDSpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonRDSResponse 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.
getCachedResponseMetadata in interface AmazonRDSrequest - The originally executed request.public AmazonRDSWaiters waiters()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.