aws rds163 CLI commands available for Amazon RDS.
| Command | API Operation | Sample |
|---|---|---|
add-role-to-db-clusterAssociates an Identity and Access Management (IAM) role with a DB cluster. | AddRoleToDBCluster | |
add-role-to-db-instanceAssociates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom. | AddRoleToDBInstance | |
add-source-identifier-to-subscriptionAdds a source identifier to an existing RDS event notification subscription. | AddSourceIdentifierToSubscription | |
add-tags-to-resourceAdds 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 your relational database resources, see Tagging Am | AddTagsToResource | |
apply-pending-maintenance-actionApplies a pending maintenance action to a resource (for example, to a DB instance). | ApplyPendingMaintenanceAction | |
authorize-db-security-group-ingressEnables 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 | AuthorizeDBSecurityGroupIngress | |
backtrack-db-clusterBacktracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB clusters. | BacktrackDBCluster | |
cancel-export-taskCancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed. | CancelExportTask | |
copy-db-cluster-parameter-groupCopies the specified DB cluster parameter group. You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family. | CopyDBClusterParameterGroup | |
copy-db-cluster-snapshotCopies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region | CopyDBClusterSnapshot | |
copy-db-parameter-groupCopies the specified DB parameter group. You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family. | CopyDBParameterGroup | |
copy-db-snapshotCopies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for | CopyDBSnapshot | |
copy-option-groupCopies the specified option group. | CopyOptionGroup | |
create-blue-green-deploymentCreates a blue/green deployment. A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the curre | CreateBlueGreenDeployment | |
create-custom-db-engine-versionCreates a custom DB engine version (CEV). | CreateCustomDBEngineVersion | |
create-db-clusterCreates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a | CreateDBCluster | |
create-db-cluster-endpointCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters. | CreateDBClusterEndpoint | |
create-db-cluster-parameter-groupCreates 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 | CreateDBClusterParameterGroup | |
create-db-cluster-snapshotCreates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. | CreateDBClusterSnapshot | |
create-db-instanceCreates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster. For more information about creating an RDS DB instance, | CreateDBInstance | |
create-db-instance-read-replicaCreates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or Po | CreateDBInstanceReadReplica | |
create-db-parameter-groupCreates 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 | CreateDBParameterGroup | |
create-db-proxyCreates a new DB proxy. | CreateDBProxy | |
create-db-proxy-endpointCreates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC. | CreateDBProxyEndpoint | |
create-db-security-groupCreates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as | CreateDBSecurityGroup | |
create-db-shard-groupCreates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only | CreateDBShardGroup | |
create-db-snapshotCreates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state. | CreateDBSnapshot | |
create-db-subnet-groupCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. | CreateDBSubnetGroup | |
create-event-subscriptionCreates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS | CreateEventSubscription | |
create-global-clusterCreates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora | CreateGlobalCluster | |
create-integrationCreates a zero-ETL integration with Amazon Redshift. | CreateIntegration | |
create-option-groupCreates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom. | CreateOptionGroup | |
create-tenant-databaseCreates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported. | CreateTenantDatabase | |
delete-blue-green-deploymentDeletes a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide. | DeleteBlueGreenDeployment | |
delete-custom-db-engine-versionDeletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snaps | DeleteCustomDBEngineVersion | |
delete-db-clusterThe DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. If you're deleting a Multi-AZ DB cluster with r | DeleteDBCluster | |
delete-db-cluster-automated-backupDeletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups. | DeleteDBClusterAutomatedBackup | |
delete-db-cluster-endpointDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. | DeleteDBClusterEndpoint | |
delete-db-cluster-parameter-groupDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cl | DeleteDBClusterParameterGroup | |
delete-db-cluster-snapshotDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi- | DeleteDBClusterSnapshot | |
delete-db-instanceDeletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted. If you request a final DB snapshot, the status of the Amazon RDS DB instance is del | DeleteDBInstance | |
delete-db-instance-automated-backupDeletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups. | DeleteDBInstanceAutomatedBackup | |
delete-db-parameter-groupDeletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. | DeleteDBParameterGroup | |
delete-db-proxyDeletes an existing DB proxy. | DeleteDBProxy | |
delete-db-proxy-endpointDeletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC. | DeleteDBProxyEndpoint | |
delete-db-security-groupDeletes a DB security group. The specified DB security group must not be associated with any DB instances. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Cla | DeleteDBSecurityGroup | |
delete-db-shard-groupDeletes an Aurora Limitless Database DB shard group. | DeleteDBShardGroup | |
delete-db-snapshotDeletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted. | DeleteDBSnapshot | |
delete-db-subnet-groupDeletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. | DeleteDBSubnetGroup | |
delete-event-subscriptionDeletes an RDS event notification subscription. | DeleteEventSubscription | |
delete-global-clusterDeletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters. | DeleteGlobalCluster | |
delete-integrationDeletes a zero-ETL integration with Amazon Redshift. | DeleteIntegration | |
delete-option-groupDeletes an existing option group. | DeleteOptionGroup | |
delete-tenant-databaseDeletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances. You can't delete a tenant database when it is the only tenant in the DB instance. | DeleteTenantDatabase | |
deregister-db-proxy-targetsRemove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup. | DeregisterDBProxyTargets | |
describe-account-attributesLists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any | DescribeAccountAttributes | |
describe-blue-green-deploymentsDescribes one or more blue/green deployments. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide. | DescribeBlueGreenDeployments | |
describe-certificatesLists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon | DescribeCertificates | |
describe-db-cluster-automated-backupsDisplays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations. All parameters are optio | DescribeDBClusterAutomatedBackups | |
describe-db-cluster-backtracksReturns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters. | DescribeDBClusterBacktracks | |
describe-db-cluster-endpointsReturns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. | DescribeDBClusterEndpoints | |
describe-db-cluster-parameter-groupsReturns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. | DescribeDBClusterParameterGroups | |
describe-db-cluster-parametersReturns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. | DescribeDBClusterParameters | |
describe-db-cluster-snapshot-attributesReturns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authori | DescribeDBClusterSnapshotAttributes | |
describe-db-cluster-snapshotsReturns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS Us | DescribeDBClusterSnapshots | |
describe-db-clustersDescribes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in t | DescribeDBClusters | |
describe-db-engine-versionsDescribes the properties of specific versions of DB engines. | DescribeDBEngineVersions | |
describe-db-instance-automated-backupsDisplays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeD | DescribeDBInstanceAutomatedBackups | |
describe-db-instancesDescribes provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. | DescribeDBInstances | |
describe-db-log-filesReturns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom. | DescribeDBLogFiles | |
describe-db-major-engine-versionsDescribes the properties of specific major versions of DB engines. | DescribeDBMajorEngineVersions | |
describe-db-parameter-groupsReturns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. | DescribeDBParameterGroups | |
describe-db-parametersReturns the detailed parameter list for a particular DB parameter group. | DescribeDBParameters | |
describe-db-proxiesReturns information about DB proxies. | DescribeDBProxies | |
describe-db-proxy-endpointsReturns information about DB proxy endpoints. | DescribeDBProxyEndpoints | |
describe-db-proxy-target-groupsReturns information about DB proxy target groups, represented by DBProxyTargetGroup data structures. | DescribeDBProxyTargetGroups | |
describe-db-proxy-targetsReturns information about DBProxyTarget objects. This API supports pagination. | DescribeDBProxyTargets | |
describe-db-recommendationsDescribes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups. | DescribeDBRecommendations | |
describe-db-security-groupsReturns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon | DescribeDBSecurityGroups | |
describe-db-shard-groupsDescribes existing Aurora Limitless Database DB shard groups. | DescribeDBShardGroups | |
describe-db-snapshot-attributesReturns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore | DescribeDBSnapshotAttributes | |
describe-db-snapshot-tenant-databasesDescribes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant database | DescribeDBSnapshotTenantDatabases | |
describe-db-snapshotsReturns information about DB snapshots. This API action supports pagination. | DescribeDBSnapshots | |
describe-db-subnet-groupsReturns 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 | |
describe-engine-default-cluster-parametersReturns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. | DescribeEngineDefaultClusterParameters | |
describe-engine-default-parametersReturns the default engine and system parameter information for the specified database engine. | DescribeEngineDefaultParameters | |
describe-event-categoriesDisplays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . | DescribeEventCategories | |
describe-event-subscriptionsLists 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 | |
describe-eventsReturns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot gro | DescribeEvents | |
describe-export-tasksReturns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination. | DescribeExportTasks | |
describe-global-clustersReturns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. | DescribeGlobalClusters | |
describe-integrationsDescribe one or more zero-ETL integrations with Amazon Redshift. | DescribeIntegrations | |
describe-option-group-optionsDescribes all available options for the specified engine. | DescribeOptionGroupOptions | |
describe-option-groupsDescribes the available option groups. | DescribeOptionGroups | |
describe-orderable-db-instance-optionsDescribes the orderable DB instance options for a specified DB engine. | DescribeOrderableDBInstanceOptions | |
describe-pending-maintenance-actionsReturns a list of resources (for example, DB instances) that have at least one pending maintenance action. This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions command might not be immediately visible to all subsequent RDS commands. Keep | DescribePendingMaintenanceActions | |
describe-reserved-db-instancesReturns information about reserved DB instances for this account, or about a specified reserved DB instance. | DescribeReservedDBInstances | |
describe-reserved-db-instances-offeringsLists available reserved DB instance offerings. | DescribeReservedDBInstancesOfferings | |
describe-source-regionsReturns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. Use this operation to determine whether cross-Region features are supported between other Regions and your cu | DescribeSourceRegions | |
describe-tenant-databasesDescribes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported. | DescribeTenantDatabases | |
describe-valid-db-instance-modificationsYou can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom. | DescribeValidDBInstanceModifications | |
disable-http-endpointDisables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API. For more information, see Using RDS Data API in the Amazon Aurora User Guide. This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aur | DisableHttpEndpoint | |
download-db-log-file-portionDownloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom. This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then using the GetLogEvents operation. For more informati | DownloadDBLogFilePortion | |
enable-http-endpointEnables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS | EnableHttpEndpoint | |
failover-db-clusterForces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the interna | FailoverDBCluster | |
failover-global-clusterPromotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers." Although this operation can be used either to fail over or to switch over | FailoverGlobalCluster | |
list-tags-for-resourceLists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide. | ListTagsForResource | |
modify-activity-streamChanges the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stre | ModifyActivityStream | |
modify-certificatesOverride the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificat | ModifyCertificates | |
modify-current-db-cluster-capacitySet the capacity of an Aurora Serverless v1 DB cluster to a specific value. Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call Mo | ModifyCurrentDBClusterCapacity | |
modify-custom-db-engine-versionModifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTr | ModifyCustomDBEngineVersion | |
modify-db-clusterModifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For mor | ModifyDBCluster | |
modify-db-cluster-endpointModifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only applies to Aurora DB clusters. | ModifyDBClusterEndpoint | |
modify-db-cluster-parameter-groupModifies 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. There are two types of parameters - dynamic parameters and stat | ModifyDBClusterParameterGroup | |
modify-db-cluster-snapshot-attributeAdds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Service | ModifyDBClusterSnapshotAttribute | |
modify-db-instanceModifies 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 | |
modify-db-parameter-groupModifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you modify a DB parameter group, you should wait at least 5 minut | ModifyDBParameterGroup | |
modify-db-proxyChanges the settings for an existing DB proxy. | ModifyDBProxy | |
modify-db-proxy-endpointChanges the settings for an existing DB proxy endpoint. | ModifyDBProxyEndpoint | |
modify-db-proxy-target-groupModifies the properties of a DBProxyTargetGroup. | ModifyDBProxyTargetGroup | |
modify-db-recommendationUpdates the recommendation status and recommended action status for the specified recommendation. | ModifyDBRecommendation | |
modify-db-shard-groupModifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request. | ModifyDBShardGroup | |
modify-db-snapshotUpdates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MariaDB, MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2. | ModifyDBSnapshot | |
modify-db-snapshot-attributeAdds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that | ModifyDBSnapshotAttribute | |
modify-db-subnet-groupModifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. | ModifyDBSubnetGroup | |
modify-event-subscriptionModifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories f | ModifyEventSubscription | |
modify-global-clusterModifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This op | ModifyGlobalCluster | |
modify-integrationModifies a zero-ETL integration with Amazon Redshift. | ModifyIntegration | |
modify-option-groupModifies an existing option group. | ModifyOptionGroup | |
modify-tenant-databaseModifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration. | ModifyTenantDatabase | |
promote-read-replicaPromotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup | PromoteReadReplica | |
promote-read-replica-db-clusterPromotes a read replica DB cluster to a standalone DB cluster. | PromoteReadReplicaDBCluster | |
purchase-reserved-db-instances-offeringPurchases a reserved DB instance offering. | PurchaseReservedDBInstancesOffering | |
reboot-db-clusterYou might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect. Rebooting a DB cluster restarts the databas | RebootDBCluster | |
reboot-db-instanceYou might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the datab | RebootDBInstance | |
reboot-db-shard-groupYou might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect. This operation applies only to Aurora Limitless Database DBb shard groups. | RebootDBShardGroup | |
register-db-proxy-targetsAssociate one or more DBProxyTarget data structures with a DBProxyTargetGroup. | RegisterDBProxyTargets | |
remove-from-global-clusterDetaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region. This operation only applies to Aurora DB clusters. | RemoveFromGlobalCluster | |
remove-role-from-db-clusterRemoves the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deplo | RemoveRoleFromDBCluster | |
remove-role-from-db-instanceDisassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance. | RemoveRoleFromDBInstance | |
remove-source-identifier-from-subscriptionRemoves a source identifier from an existing RDS event notification subscription. | RemoveSourceIdentifierFromSubscription | |
remove-tags-from-resourceRemoves metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide. | RemoveTagsFromResource | |
reset-db-cluster-parameter-groupModifies 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 re | ResetDBClusterParameterGroup | |
reset-db-parameter-groupModifies 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 resettin | ResetDBParameterGroup | |
restore-db-cluster-from-s3Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Auro | RestoreDBClusterFromS3 | |
restore-db-cluster-from-snapshotCreates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This operation only restores the DB cl | RestoreDBClusterFromSnapshot | |
restore-db-cluster-to-point-in-timeRestores 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 clu | RestoreDBClusterToPointInTime | |
restore-db-instance-from-db-snapshotCreates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, exc | RestoreDBInstanceFromDBSnapshot | |
restore-db-instance-from-s3Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For | RestoreDBInstanceFromS3 | |
restore-db-instance-to-point-in-timeRestores 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 | RestoreDBInstanceToPointInTime | |
revoke-db-security-group-ingressRevokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). EC2-Classic was retired on Au | RevokeDBSecurityGroupIngress | |
start-activity-streamStarts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide. | StartActivityStream | |
start-db-clusterStarts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB cl | StartDBCluster | |
start-db-instanceStarts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't a | StartDBInstance | |
start-db-instance-automated-backups-replicationEnables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. | StartDBInstanceAutomatedBackupsReplication | |
start-export-taskStarts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS. For more inf | StartExportTask | |
stop-activity-streamStops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amaz | StopActivityStream | |
stop-db-clusterStops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an A | StopDBCluster | |
stop-db-instanceStops an Amazon RDS DB instance temporarily. 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. The insta | StopDBInstance | |
stop-db-instance-automated-backups-replicationStops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. | StopDBInstanceAutomatedBackupsReplication | |
switchover-blue-green-deploymentSwitches over a blue/green deployment. Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment. For more information, see Using Amazon RDS Blue/Green Deployments for d | SwitchoverBlueGreenDeployment | |
switchover-global-clusterSwitches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers." Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current p | SwitchoverGlobalCluster | |
switchover-read-replicaSwitches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database. | SwitchoverReadReplica |
Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.
Download Free InfographicEverything you need to know about Amazon RDS on one page. HD quality, print-friendly.
Download Free InfographicRDS