# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AddRoleToDBCluster](API_AddRoleToDBCluster.md) 
+  [AddRoleToDBInstance](API_AddRoleToDBInstance.md) 
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [AuthorizeDBSecurityGroupIngress](API_AuthorizeDBSecurityGroupIngress.md) 
+  [BacktrackDBCluster](API_BacktrackDBCluster.md) 
+  [CancelExportTask](API_CancelExportTask.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CopyDBParameterGroup](API_CopyDBParameterGroup.md) 
+  [CopyDBSnapshot](API_CopyDBSnapshot.md) 
+  [CopyOptionGroup](API_CopyOptionGroup.md) 
+  [CreateBlueGreenDeployment](API_CreateBlueGreenDeployment.md) 
+  [CreateCustomDBEngineVersion](API_CreateCustomDBEngineVersion.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterEndpoint](API_CreateDBClusterEndpoint.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBInstanceReadReplica](API_CreateDBInstanceReadReplica.md) 
+  [CreateDBParameterGroup](API_CreateDBParameterGroup.md) 
+  [CreateDBProxy](API_CreateDBProxy.md) 
+  [CreateDBProxyEndpoint](API_CreateDBProxyEndpoint.md) 
+  [CreateDBSecurityGroup](API_CreateDBSecurityGroup.md) 
+  [CreateDBShardGroup](API_CreateDBShardGroup.md) 
+  [CreateDBSnapshot](API_CreateDBSnapshot.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [CreateIntegration](API_CreateIntegration.md) 
+  [CreateOptionGroup](API_CreateOptionGroup.md) 
+  [CreateTenantDatabase](API_CreateTenantDatabase.md) 
+  [DeleteBlueGreenDeployment](API_DeleteBlueGreenDeployment.md) 
+  [DeleteCustomDBEngineVersion](API_DeleteCustomDBEngineVersion.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterAutomatedBackup](API_DeleteDBClusterAutomatedBackup.md) 
+  [DeleteDBClusterEndpoint](API_DeleteDBClusterEndpoint.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBInstanceAutomatedBackup](API_DeleteDBInstanceAutomatedBackup.md) 
+  [DeleteDBParameterGroup](API_DeleteDBParameterGroup.md) 
+  [DeleteDBProxy](API_DeleteDBProxy.md) 
+  [DeleteDBProxyEndpoint](API_DeleteDBProxyEndpoint.md) 
+  [DeleteDBSecurityGroup](API_DeleteDBSecurityGroup.md) 
+  [DeleteDBShardGroup](API_DeleteDBShardGroup.md) 
+  [DeleteDBSnapshot](API_DeleteDBSnapshot.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DeleteIntegration](API_DeleteIntegration.md) 
+  [DeleteOptionGroup](API_DeleteOptionGroup.md) 
+  [DeleteTenantDatabase](API_DeleteTenantDatabase.md) 
+  [DeregisterDBProxyTargets](API_DeregisterDBProxyTargets.md) 
+  [DescribeAccountAttributes](API_DescribeAccountAttributes.md) 
+  [DescribeBlueGreenDeployments](API_DescribeBlueGreenDeployments.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterAutomatedBackups](API_DescribeDBClusterAutomatedBackups.md) 
+  [DescribeDBClusterBacktracks](API_DescribeDBClusterBacktracks.md) 
+  [DescribeDBClusterEndpoints](API_DescribeDBClusterEndpoints.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstanceAutomatedBackups](API_DescribeDBInstanceAutomatedBackups.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBLogFiles](API_DescribeDBLogFiles.md) 
+  [DescribeDBMajorEngineVersions](API_DescribeDBMajorEngineVersions.md) 
+  [DescribeDBParameterGroups](API_DescribeDBParameterGroups.md) 
+  [DescribeDBParameters](API_DescribeDBParameters.md) 
+  [DescribeDBProxies](API_DescribeDBProxies.md) 
+  [DescribeDBProxyEndpoints](API_DescribeDBProxyEndpoints.md) 
+  [DescribeDBProxyTargetGroups](API_DescribeDBProxyTargetGroups.md) 
+  [DescribeDBProxyTargets](API_DescribeDBProxyTargets.md) 
+  [DescribeDBRecommendations](API_DescribeDBRecommendations.md) 
+  [DescribeDBSecurityGroups](API_DescribeDBSecurityGroups.md) 
+  [DescribeDBShardGroups](API_DescribeDBShardGroups.md) 
+  [DescribeDBSnapshotAttributes](API_DescribeDBSnapshotAttributes.md) 
+  [DescribeDBSnapshots](API_DescribeDBSnapshots.md) 
+  [DescribeDBSnapshotTenantDatabases](API_DescribeDBSnapshotTenantDatabases.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEngineDefaultParameters](API_DescribeEngineDefaultParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeExportTasks](API_DescribeExportTasks.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeIntegrations](API_DescribeIntegrations.md) 
+  [DescribeOptionGroupOptions](API_DescribeOptionGroupOptions.md) 
+  [DescribeOptionGroups](API_DescribeOptionGroups.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [DescribeReservedDBInstances](API_DescribeReservedDBInstances.md) 
+  [DescribeReservedDBInstancesOfferings](API_DescribeReservedDBInstancesOfferings.md) 
+  [DescribeServerlessV2PlatformVersions](API_DescribeServerlessV2PlatformVersions.md) 
+  [DescribeSourceRegions](API_DescribeSourceRegions.md) 
+  [DescribeTenantDatabases](API_DescribeTenantDatabases.md) 
+  [DescribeValidDBInstanceModifications](API_DescribeValidDBInstanceModifications.md) 
+  [DisableHttpEndpoint](API_DisableHttpEndpoint.md) 
+  [DownloadDBLogFilePortion](API_DownloadDBLogFilePortion.md) 
+  [EnableHttpEndpoint](API_EnableHttpEndpoint.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyActivityStream](API_ModifyActivityStream.md) 
+  [ModifyCertificates](API_ModifyCertificates.md) 
+  [ModifyCurrentDBClusterCapacity](API_ModifyCurrentDBClusterCapacity.md) 
+  [ModifyCustomDBEngineVersion](API_ModifyCustomDBEngineVersion.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterEndpoint](API_ModifyDBClusterEndpoint.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBParameterGroup](API_ModifyDBParameterGroup.md) 
+  [ModifyDBProxy](API_ModifyDBProxy.md) 
+  [ModifyDBProxyEndpoint](API_ModifyDBProxyEndpoint.md) 
+  [ModifyDBProxyTargetGroup](API_ModifyDBProxyTargetGroup.md) 
+  [ModifyDBRecommendation](API_ModifyDBRecommendation.md) 
+  [ModifyDBShardGroup](API_ModifyDBShardGroup.md) 
+  [ModifyDBSnapshot](API_ModifyDBSnapshot.md) 
+  [ModifyDBSnapshotAttribute](API_ModifyDBSnapshotAttribute.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [ModifyIntegration](API_ModifyIntegration.md) 
+  [ModifyOptionGroup](API_ModifyOptionGroup.md) 
+  [ModifyTenantDatabase](API_ModifyTenantDatabase.md) 
+  [PromoteReadReplica](API_PromoteReadReplica.md) 
+  [PromoteReadReplicaDBCluster](API_PromoteReadReplicaDBCluster.md) 
+  [PurchaseReservedDBInstancesOffering](API_PurchaseReservedDBInstancesOffering.md) 
+  [RebootDBCluster](API_RebootDBCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RebootDBShardGroup](API_RebootDBShardGroup.md) 
+  [RegisterDBProxyTargets](API_RegisterDBProxyTargets.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveRoleFromDBCluster](API_RemoveRoleFromDBCluster.md) 
+  [RemoveRoleFromDBInstance](API_RemoveRoleFromDBInstance.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [ResetDBParameterGroup](API_ResetDBParameterGroup.md) 
+  [RestoreDBClusterFromS3](API_RestoreDBClusterFromS3.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [RestoreDBInstanceFromDBSnapshot](API_RestoreDBInstanceFromDBSnapshot.md) 
+  [RestoreDBInstanceFromS3](API_RestoreDBInstanceFromS3.md) 
+  [RestoreDBInstanceToPointInTime](API_RestoreDBInstanceToPointInTime.md) 
+  [RevokeDBSecurityGroupIngress](API_RevokeDBSecurityGroupIngress.md) 
+  [StartActivityStream](API_StartActivityStream.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StartDBInstance](API_StartDBInstance.md) 
+  [StartDBInstanceAutomatedBackupsReplication](API_StartDBInstanceAutomatedBackupsReplication.md) 
+  [StartExportTask](API_StartExportTask.md) 
+  [StopActivityStream](API_StopActivityStream.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [StopDBInstance](API_StopDBInstance.md) 
+  [StopDBInstanceAutomatedBackupsReplication](API_StopDBInstanceAutomatedBackupsReplication.md) 
+  [SwitchoverBlueGreenDeployment](API_SwitchoverBlueGreenDeployment.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 
+  [SwitchoverReadReplica](API_SwitchoverReadReplica.md) 

# AddRoleToDBCluster
<a name="API_AddRoleToDBCluster"></a>

Associates an AWS Identity and Access Management (IAM) role with a DB cluster.

## Request Parameters
<a name="API_AddRoleToDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the DB cluster to associate the IAM role with.  
Type: String  
Required: Yes

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example `arn:aws:iam::123456789012:role/AuroraAccessRole`.  
Type: String  
Required: Yes

 ** FeatureName **   
The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see [DBEngineVersion](API_DBEngineVersion.md).  
Type: String  
Required: No

## Errors
<a name="API_AddRoleToDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterRoleAlreadyExists **   
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.  
HTTP Status Code: 400

 ** DBClusterRoleQuotaExceeded **   
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_AddRoleToDBCluster_Examples"></a>

### Example
<a name="API_AddRoleToDBCluster_Example_1"></a>

This example illustrates one usage of AddRoleToDBCluster.

#### Sample Request
<a name="API_AddRoleToDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=AddRoleToDBCluster
    &DBClusterIdentifier=sample-cluster
    &RoleArn=arn%3Aaws%3Aiam%3A%3A123456789012%3Arole%2Fsample-role
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20161012/us-east-1/rds/aws4_request
    &X-Amz-Date=20161012T204524Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=d73c069210f98e5377851fa4c4ab2fdd53e8bd5d5f02f4f8ef15d4daa5b04567
```

#### Sample Response
<a name="API_AddRoleToDBCluster_Example_1_Response"></a>

```
<AddRoleToDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>ccccbdb6-90bc-11e6-8533-cd6447e421f8</RequestId>
  </ResponseMetadata>
</AddRoleToDBClusterResponse>
```

## See Also
<a name="API_AddRoleToDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/AddRoleToDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AddRoleToDBCluster) 

# AddRoleToDBInstance
<a name="API_AddRoleToDBInstance"></a>

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

**Note**  
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.

## Request Parameters
<a name="API_AddRoleToDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The name of the DB instance to associate the IAM role with.  
Type: String  
Required: Yes

 ** FeatureName **   
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see [DBEngineVersion](API_DBEngineVersion.md).  
Type: String  
Required: Yes

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example `arn:aws:iam::123456789012:role/AccessRole`.  
Type: String  
Required: Yes

## Errors
<a name="API_AddRoleToDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBInstanceRoleAlreadyExists **   
The specified `RoleArn` or `FeatureName` value is already associated with the DB instance.  
HTTP Status Code: 400

 ** DBInstanceRoleQuotaExceeded **   
You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_AddRoleToDBInstance_Examples"></a>

### Example
<a name="API_AddRoleToDBInstance_Example_1"></a>

This example illustrates one usage of AddRoleToDBInstance.

#### Sample Request
<a name="API_AddRoleToDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=AddRoleToDBInstance
    &DBInstanceIdentifier=sample-instance
    &RoleArn=arn%3Aaws%3Aiam%3A%3A123456789012%3Arole%2Fsample-role
    &FeatureName=s3Import
```

## See Also
<a name="API_AddRoleToDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/AddRoleToDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AddRoleToDBInstance) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

Adds a source identifier to an existing RDS event notification subscription.

## Request Parameters
<a name="API_AddSourceIdentifierToSubscription_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceIdentifier **   
The identifier of the event source to be added.  
Constraints:  
+ If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied.
+ If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied.
+ If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied.
+ If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied.
+ If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied.
+ If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied.
+ If the source type is an RDS Proxy, a `DBProxyName` value must be supplied.
Type: String  
Required: Yes

 ** SubscriptionName **   
The name of the RDS event notification subscription you want to add a source identifier to.  
Type: String  
Required: Yes

## Response Elements
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

The following element is returned by the service.

 ** EventSubscription **   
Contains the results of a successful invocation of the `DescribeEventSubscriptions` action.  
Type: [EventSubscription](API_EventSubscription.md) object

## Errors
<a name="API_AddSourceIdentifierToSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** SourceNotFound **   
The requested source could not be found.  
HTTP Status Code: 404

 ** SubscriptionNotFound **   
The subscription name does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_AddSourceIdentifierToSubscription_Examples"></a>

### Example
<a name="API_AddSourceIdentifierToSubscription_Example_1"></a>

This example illustrates one usage of AddSourceIdentifierToSubscription.

#### Sample Request
<a name="API_AddSourceIdentifierToSubscription_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=AddSourceIdentifierToSubscription
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceIdentifier=mysqldb
   &SubscriptionName=EventSubscription04
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140422/us-east-1/rds/aws4_request
   &X-Amz-Date=20140422T230442Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=347d5e788e809cd06c50214b12750a3c39716bf65b239bb6f7ee8ff5374e2df9
```

#### Sample Response
<a name="API_AddSourceIdentifierToSubscription_Example_1_Response"></a>

```
<AddSourceIdentifierToSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <AddSourceIdentifierToSubscriptionResult>
    <EventSubscription>
      <SourceType>db-instance</SourceType>
      <Enabled>true</Enabled>
      <CustomerAwsId>803#########</CustomerAwsId>
      <Status>modifying</Status>
      <SourceIdsList>
        <SourceId>mysqldb</SourceId>
      </SourceIdsList>
      <SubscriptionCreationTime>2014-04-22 23:03:19.776</SubscriptionCreationTime>
      <EventCategoriesList>
        <EventCategory>creation</EventCategory>
        <EventCategory>deletion</EventCategory>
      </EventCategoriesList>
      <CustSubscriptionId>EventSubscription04</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-east-1:803#########:mytopic</SnsTopicArn>
    </EventSubscription>
  </AddSourceIdentifierToSubscriptionResult>
  <ResponseMetadata>
    <RequestId>6c05f0b0-bf71-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</AddSourceIdentifierToSubscriptionResponse>
```

## See Also
<a name="API_AddSourceIdentifierToSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AddSourceIdentifierToSubscription) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging your relational database resources, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html). 

## Request Parameters
<a name="API_AddTagsToResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see [ Constructing an RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).  
Type: String  
Required: Yes

 **Tags.Tag.N**   
The tags to be assigned to the Amazon RDS resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Errors
<a name="API_AddTagsToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSnapshotTenantDatabaseNotFoundFault **   
The specified snapshot tenant database wasn't found.  
HTTP Status Code: 404

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

 ** InvalidDBClusterEndpointStateFault **   
The requested operation can't be performed on the endpoint while the endpoint is in this state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** TenantDatabaseNotFound **   
The specified tenant database wasn't found in the DB instance.  
HTTP Status Code: 404

## Examples
<a name="API_AddTagsToResource_Examples"></a>

### Example
<a name="API_AddTagsToResource_Example_1"></a>

This example illustrates one usage of AddTagsToResource.

#### Sample Request
<a name="API_AddTagsToResource_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=AddTagsToResource
    &ResourceName=arn%3Aaws%3Ards%3Aus-west-2%3A123456789012%3Adb%3Asample
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Tags.member.1.Key=InstanceType
    &Tags.member.1.Value=Development
    &Tags.member.2.Key=Owner
    &Tags.member.2.Value=Admin123
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
    &X-Amz-Date=20160913T173915Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=90a257aa949fab364b7db0964a255986922f933f2e55e7b582ce6f9ccca2a4e0
```

#### Sample Response
<a name="API_AddTagsToResource_Example_1_Response"></a>

```
<AddTagsToResourceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>fd9cd844-79d8-11e6-956c-915ad715fa2f</RequestId>
  </ResponseMetadata>
</AddTagsToResourceResponse>
```

## See Also
<a name="API_AddTagsToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AddTagsToResource) 

# ApplyPendingMaintenanceAction
<a name="API_ApplyPendingMaintenanceAction"></a>

Applies a pending maintenance action to a resource (for example, to a DB instance).

## Request Parameters
<a name="API_ApplyPendingMaintenanceAction_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyAction **   
The pending maintenance action to apply to this resource.  
Valid Values:  
+  `ca-certificate-rotation` 
+  `db-upgrade` 
+  `hardware-maintenance` 
+  `os-upgrade` 
+  `system-update` 
For more information about these actions, see [Maintenance actions for Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora) or [Maintenance actions for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds).  
Type: String  
Required: Yes

 ** OptInType **   
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type `immediate` can't be undone.  
Valid Values:  
+  `immediate` - Apply the maintenance action immediately.
+  `next-maintenance` - Apply the maintenance action during the next maintenance window for the resource.
+  `undo-opt-in` - Cancel any existing `next-maintenance` opt-in requests.
Type: String  
Required: Yes

 ** ResourceIdentifier **   
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see [ Constructing an RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).  
Type: String  
Required: Yes

## Response Elements
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

The following element is returned by the service.

 ** ResourcePendingMaintenanceActions **   
Describes the pending maintenance actions for a resource.  
Type: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) object

## Errors
<a name="API_ApplyPendingMaintenanceAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## Examples
<a name="API_ApplyPendingMaintenanceAction_Examples"></a>

### Example
<a name="API_ApplyPendingMaintenanceAction_Example_1"></a>

This example illustrates one usage of ApplyPendingMaintenanceAction.

#### Sample Request
<a name="API_ApplyPendingMaintenanceAction_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=ApplyPendingMaintenanceAction
   &ResourceIdentifier=arn:aws:rds:us-east-1:123456781234:db:my-instance
   &ApplyAction=system-update
   &OptInType=immediate
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141216/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
```

#### Sample Response
<a name="API_ApplyPendingMaintenanceAction_Example_1_Response"></a>

```
<ApplyPendingMaintenanceActionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ApplyPendingMaintenanceActionResult>
     <ResourcePendingMaintenanceActions>
      <ResourceIdentifier>arn:aws:rds:us-east-1:123456781234:db:my-instance</ResourceIdentifier>
      <PendingMaintenanceActionDetails>
        <PendingMaintenanceAction>
          <Action>system-update</Action>
          <OptInStatus>immediate</OptInStatus>
        </PendingMaintenanceAction>
      </PendingMaintenanceActionDetails>
     /ResourcePendingMaintenanceActions>
  </ApplyPendingMaintenanceActionResult>
  <ResponseMetadata>
    <RequestId>dcfe0682-870c-11e4-9833-b3ad657ea9da</RequestId>
  </ResponseMetadata>
</ApplyPendingMaintenanceActionResponse>
```

## See Also
<a name="API_ApplyPendingMaintenanceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ApplyPendingMaintenanceAction) 

# AuthorizeDBSecurityGroupIngress
<a name="API_AuthorizeDBSecurityGroupIngress"></a>

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

**Note**  
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-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_AuthorizeDBSecurityGroupIngress_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSecurityGroupName **   
The name of the DB security group to add authorization to.  
Type: String  
Required: Yes

 ** CIDRIP **   
The IP range to authorize.  
Type: String  
Required: No

 ** EC2SecurityGroupId **   
Id of the EC2 security group to authorize. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

 ** EC2SecurityGroupName **   
Name of the EC2 security group to authorize. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

 ** EC2SecurityGroupOwnerId **   
 AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

## Response Elements
<a name="API_AuthorizeDBSecurityGroupIngress_ResponseElements"></a>

The following element is returned by the service.

 ** DBSecurityGroup **   
Contains the details for an Amazon RDS DB security group.  
This data type is used as a response element in the `DescribeDBSecurityGroups` action.  
Type: [DBSecurityGroup](API_DBSecurityGroup.md) object

## Errors
<a name="API_AuthorizeDBSecurityGroupIngress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationAlreadyExists **   
The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.  
HTTP Status Code: 400

 ** AuthorizationQuotaExceeded **   
The DB security group authorization quota has been reached.  
HTTP Status Code: 400

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** InvalidDBSecurityGroupState **   
The state of the DB security group doesn't allow deletion.  
HTTP Status Code: 400

## Examples
<a name="API_AuthorizeDBSecurityGroupIngress_Examples"></a>

### Example
<a name="API_AuthorizeDBSecurityGroupIngress_Example_1"></a>

This example illustrates one usage of AuthorizeDBSecurityGroupIngress.

#### Sample Request
<a name="API_AuthorizeDBSecurityGroupIngress_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=AuthorizeDBSecurityGroupIngress
   &CIDRIP=54.241.217.9%2F32
   &DBSecurityGroupName=default
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T154632Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=7803146e430626f47b0da058921cdb9f2ab7ffd881bd99fc859f2f635e4472bd
```

#### Sample Response
<a name="API_AuthorizeDBSecurityGroupIngress_Example_1_Response"></a>

```
<AuthorizeDBSecurityGroupIngressResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <AuthorizeDBSecurityGroupIngressResult>
    <DBSecurityGroup>
      <EC2SecurityGroups>
        <EC2SecurityGroup>
          <Status>authorized</Status>
          <EC2SecurityGroupName>elasticbeanstalk-windows</EC2SecurityGroupName>
          <EC2SecurityGroupOwnerId>803#########</EC2SecurityGroupOwnerId>
          <EC2SecurityGroupId>sg-7f476617</EC2SecurityGroupId>
        </EC2SecurityGroup>
      </EC2SecurityGroups>
      <DBSecurityGroupDescription>default</DBSecurityGroupDescription>
      <IPRanges>
        <IPRange>
          <CIDRIP>192.0.0.0/24</CIDRIP>
          <Status>authorized</Status>
        </IPRange>
        <IPRange>
          <CIDRIP>190.0.1.0/29</CIDRIP>
          <Status>authorized</Status>
        </IPRange>
        <IPRange>
          <CIDRIP>190.0.2.0/29</CIDRIP>
          <Status>authorized</Status>
        </IPRange>
        <IPRange>
          <CIDRIP>10.0.0.0/8</CIDRIP>
          <Status>authorized</Status>
        </IPRange>
      </IPRanges>
      <OwnerId>803#########</OwnerId>
      <DBSecurityGroupName>default</DBSecurityGroupName>
    </DBSecurityGroup>
  </AuthorizeDBSecurityGroupIngressResult>
  <ResponseMetadata>
    <RequestId>6176b5f8-bfed-11d3-f92b-31fa5e8dbc99</RequestId>
  </ResponseMetadata>
</AuthorizeDBSecurityGroupIngressResponse>
```

## See Also
<a name="API_AuthorizeDBSecurityGroupIngress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/AuthorizeDBSecurityGroupIngress) 

# BacktrackDBCluster
<a name="API_BacktrackDBCluster"></a>

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see [ Backtracking an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html) in the *Amazon Aurora User Guide*.

**Note**  
This action applies only to Aurora MySQL DB clusters.

## Request Parameters
<a name="API_BacktrackDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BacktrackTo **   
The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the [ISO8601 Wikipedia page.](http://en.wikipedia.org/wiki/ISO_8601)   
If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:  
+ Must contain a valid ISO 8601 timestamp.
+ Can't contain a timestamp set in the future.
Example: `2017-07-08T18:00Z`   
Type: Timestamp  
Required: Yes

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 alphanumeric characters or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster1`   
Type: String  
Required: Yes

 ** Force **   
Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.  
Type: Boolean  
Required: No

 ** UseEarliestTimeOnPointInTimeUnavailable **   
Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when *BacktrackTo* is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and *BacktrackTo* is set to a timestamp earlier than the earliest backtrack time, an error occurs.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_BacktrackDBCluster_ResponseElements"></a>

The following elements are returned by the service.

 ** BacktrackedFrom **   
The timestamp of the time from which the DB cluster was backtracked.  
Type: Timestamp

 ** BacktrackIdentifier **   
Contains the backtrack identifier.  
Type: String

 ** BacktrackRequestCreationTime **   
The timestamp of the time at which the backtrack was requested.  
Type: Timestamp

 ** BacktrackTo **   
The timestamp of the time to which the DB cluster was backtracked.  
Type: Timestamp

 ** DBClusterIdentifier **   
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.  
Type: String

 ** Status **   
The status of the backtrack. This property returns one of the following values:  
+  `applying` - The backtrack is currently being applied to or rolled back from the DB cluster.
+  `completed` - The backtrack has successfully been applied to or rolled back from the DB cluster.
+  `failed` - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
+  `pending` - The backtrack is currently pending application to or rollback from the DB cluster.
Type: String

## Errors
<a name="API_BacktrackDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_BacktrackDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/BacktrackDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/BacktrackDBCluster) 

# CancelExportTask
<a name="API_CancelExportTask"></a>

Cancels 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.

## Request Parameters
<a name="API_CancelExportTask_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ExportTaskIdentifier **   
The identifier of the snapshot or cluster export task to cancel.  
Type: String  
Required: Yes

## Response Elements
<a name="API_CancelExportTask_ResponseElements"></a>

The following elements are returned by the service.

 **ExportOnly.member.N**   
The data exported from the snapshot or cluster.  
Valid Values:  
+  `database` - Export all the data from a specified database.
+  `database.table` *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
+  `database.schema` *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
+  `database.schema.table` *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Type: Array of strings

 ** ExportTaskIdentifier **   
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.  
Type: String

 ** FailureCause **   
The reason the export failed, if it failed.  
Type: String

 ** IamRoleArn **   
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.  
Type: String

 ** KmsKeyId **   
The key identifier of the AWS KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.  
Type: String

 ** PercentProgress **   
The progress of the snapshot or cluster export task as a percentage.  
Type: Integer

 ** S3Bucket **   
The Amazon S3 bucket where the snapshot or cluster is exported to.  
Type: String

 ** S3Prefix **   
The Amazon S3 bucket prefix that is the file name and path of the exported data.  
Type: String

 ** SnapshotTime **   
The time when the snapshot was created.  
Type: Timestamp

 ** SourceArn **   
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.  
Type: String

 ** SourceType **   
The type of source for the export.  
Type: String  
Valid Values: `SNAPSHOT | CLUSTER` 

 ** Status **   
The progress status of the export task. The status can be one of the following:  
+  `CANCELED` 
+  `CANCELING` 
+  `COMPLETE` 
+  `FAILED` 
+  `IN_PROGRESS` 
+  `STARTING` 
Type: String

 ** TaskEndTime **   
The time when the snapshot or cluster export task ended.  
Type: Timestamp

 ** TaskStartTime **   
The time when the snapshot or cluster export task started.  
Type: Timestamp

 ** TotalExtractedDataInGB **   
The total amount of data exported, in gigabytes.  
Type: Integer

 ** WarningMessage **   
A warning about the snapshot or cluster export task.  
Type: String

## Errors
<a name="API_CancelExportTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ExportTaskNotFound **   
The export task doesn't exist.  
HTTP Status Code: 404

 ** InvalidExportTaskStateFault **   
You can't cancel an export task that has completed.  
HTTP Status Code: 400

## See Also
<a name="API_CancelExportTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CancelExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CancelExportTask) 

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

Copies the specified DB cluster parameter group.

**Note**  
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.

## Request Parameters
<a name="API_CopyDBClusterParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBClusterParameterGroupIdentifier **   
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see [ Constructing an ARN for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the *Amazon Aurora User Guide*.  
Constraints:  
+ Must specify a valid DB cluster parameter group.
Type: String  
Required: Yes

 ** TargetDBClusterParameterGroupDescription **   
A description for the copied DB cluster parameter group.  
Type: String  
Required: Yes

 ** TargetDBClusterParameterGroupIdentifier **   
The identifier for the copied DB cluster parameter group.  
Constraints:  
+ Can't be null, empty, or blank
+ Must contain from 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-cluster-param-group1`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterParameterGroup **   
Contains the details of an Amazon RDS DB cluster parameter group.  
This data type is used as a response element in the `DescribeDBClusterParameterGroups` action.  
Type: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) object

## Errors
<a name="API_CopyDBClusterParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
A DB parameter group with the same name exists.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBParameterGroupQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB parameter groups.  
HTTP Status Code: 400

## Examples
<a name="API_CopyDBClusterParameterGroup_Examples"></a>

### Example
<a name="API_CopyDBClusterParameterGroup_Example_1"></a>

This example illustrates one usage of CopyDBClusterParameterGroup.

#### Sample Request
<a name="API_CopyDBClusterParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CopyDBClusterParameterGroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceDBClusterParameterGroupIdentifier=arn%3Aaws%3Ards%3Aus-east-1%3A815981987263%3cluster-pg%3Amy-cluster-pg
   &TargetDBParameterGroupIdentifier=new-cluster-pg
   &TargetDBParameterGroupDescription=New%20cluster%20group
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20160705/us-east-1/rds/aws4_request
   &X-Amz-Date=20160705T143101Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2
```

#### Sample Response
<a name="API_CopyDBClusterParameterGroup_Example_1_Response"></a>

```
<CopyDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBClusterParameterGroupResult>
    <DBClusterParameterGroup>
      <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily>
      <Description>New cluster group</Description>
      <DBClusterParameterGroupName>new-cluster-pg</DBClusterParameterGroupName>
    </DBClusterParameterGroup>
  </CreateDBClusterParameterGroupResult>
  <ResponseMetadata>
    <RequestId>ae81a963-cd9d-11e4-8b88-8351746a4c92</RequestId>
  </ResponseMetadata>
</CopyDBClusterParameterGroupResponse>
```

## See Also
<a name="API_CopyDBClusterParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CopyDBClusterParameterGroup) 

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the `CopyDBClusterSnapshot` operation is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:
+  `KmsKeyId` - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.
+  `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 presigned 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 Amazon Aurora DB cluster snapshots from one AWS Region to another, see [ Copying a Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html) in the *Amazon Aurora User Guide*.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_CopyDBClusterSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBClusterSnapshotIdentifier **   
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.  
Constraints:  
+ Must specify a valid source snapshot in the "available" state.
+ If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
+ If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different AWS Region. For more information, go to [ Copying Snapshots Across AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions) in the *Amazon Aurora User Guide*.
Example: `my-cluster-snapshot1`   
Type: String  
Required: Yes

 ** TargetDBClusterSnapshotIdentifier **   
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster-snapshot2`   
Type: String  
Required: Yes

 ** CopyTags **   
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.  
Type: Boolean  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS key.  
If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for `KmsKeyId` to encrypt the copy with a new KMS key. If you don't specify a value for `KmsKeyId`, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.  
If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for `KmsKeyId`.  
To copy an encrypted DB cluster snapshot to another AWS Region, you must set `KmsKeyId` to the AWS KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS keys are specific to the AWS Region that they are created in, and you can't use KMS keys from one AWS Region in another AWS Region.  
If you copy an unencrypted DB cluster snapshot and specify a value for the `KmsKeyId` parameter, an error is returned.  
Type: String  
Required: No

 ** PreSignedUrl **   
When you are copying a DB cluster snapshot from one AWS GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the `CopyDBClusterSnapshot` API operation in the AWS Region that contains the source DB cluster snapshot to copy. Use the `PreSignedUrl` parameter when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify `PreSignedUrl` when copying an encrypted DB cluster snapshot in the same AWS Region.  
This setting applies only to AWS GovCloud (US) Regions. It's ignored in other AWS Regions.  
The presigned URL must be a valid request for the `CopyDBClusterSnapshot` API operation that can run in the source AWS Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:  
+  `KmsKeyId` - The AWS KMS key identifier for the KMS 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` operation that is called in the destination AWS Region, and the operation contained in the presigned URL.
+  `DestinationRegion` - The name of the AWS Region that the DB cluster snapshot is to be created in.
+  `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your `SourceDBClusterSnapshotIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
To learn how to generate a Signature Version 4 signed request, see [ Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and [ Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).  
If you are using an AWS SDK tool or the AWS CLI, you can specify `SourceRegion` (or `--source-region` for the AWS CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source AWS Region.
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterSnapshot **   
Contains the details for an Amazon RDS DB cluster snapshot  
This data type is used as a response element in the `DescribeDBClusterSnapshots` action.  
Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object

## Errors
<a name="API_CopyDBClusterSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterSnapshotAlreadyExistsFault **   
The user already has a DB cluster snapshot with the given identifier.  
HTTP Status Code: 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_CopyDBClusterSnapshot_Examples"></a>

### Example
<a name="API_CopyDBClusterSnapshot_Example_1"></a>

This example illustrates one usage of CopyDBClusterSnapshot.

#### Sample Request
<a name="API_CopyDBClusterSnapshot_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=CopyDBClusterSnapshot
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &SourceDBClusterSnapshotIdentifier=rds%3Asample-cluster-2016-09-14-10-38
    &TargetDBClusterSnapshotIdentifier=cluster-snapshot-copy-1
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160914/us-west-2/rds/aws4_request
    &X-Amz-Date=20160914T164919Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=4503d6112f2ab5332d7d1871cba6b97ddcc9748d3d4da0cb2c219ace80cfd384
```

#### Sample Response
<a name="API_CopyDBClusterSnapshot_Example_1_Response"></a>

```
<CopyDBClusterSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CopyDBClusterSnapshotResult>
    <DBClusterSnapshot>
      <MasterUsername>mymasteruser</MasterUsername>
      <AllocatedStorage>1</AllocatedStorage>
      <SnapshotType>manual</SnapshotType>
      <AvailabilityZones>
        <AvailabilityZone>us-west-2a</AvailabilityZone>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <AvailabilityZone>us-west-2c</AvailabilityZone>
      </AvailabilityZones>
      <StorageEncrypted>false</StorageEncrypted>
      <Engine>aurora</Engine>
      <Port>0</Port>
      <LicenseModel>aurora</LicenseModel>
      <SnapshotCreateTime>2016-09-14T10:38:05.616Z</SnapshotCreateTime>
      <PercentProgress>100</PercentProgress>
      <VpcId>vpc-e97e7d8d</VpcId>
      <DBClusterSnapshotIdentifier>cluster-snapshot-copy-1</DBClusterSnapshotIdentifier>
      <DBClusterSnapshotArn>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:cluster-snapshot-copy-1</DBClusterSnapshotArn>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <ClusterCreateTime>2016-09-13T16:57:52.695Z</ClusterCreateTime>
      <Status>available</Status>
    </DBClusterSnapshot>
  </CopyDBClusterSnapshotResult>
  <ResponseMetadata>
    <RequestId>2e861f29-7a9b-11e6-94c8-21ac69ee8f8c</RequestId>
  </ResponseMetadata>
</CopyDBClusterSnapshotResponse>
```

## See Also
<a name="API_CopyDBClusterSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CopyDBClusterSnapshot) 

# CopyDBParameterGroup
<a name="API_CopyDBParameterGroup"></a>

Copies the specified DB parameter group.

**Note**  
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.

## Request Parameters
<a name="API_CopyDBParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBParameterGroupIdentifier **   
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see [ Constructing an ARN for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the *Amazon RDS User Guide*.  
Constraints:  
+ Must specify a valid DB parameter group.
Type: String  
Required: Yes

 ** TargetDBParameterGroupDescription **   
A description for the copied DB parameter group.  
Type: String  
Required: Yes

 ** TargetDBParameterGroupIdentifier **   
The identifier for the copied DB parameter group.  
Constraints:  
+ Can't be null, empty, or blank
+ Must contain from 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-db-parameter-group`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CopyDBParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBParameterGroup **   
Contains the details of an Amazon RDS DB parameter group.  
This data type is used as a response element in the `DescribeDBParameterGroups` action.  
Type: [DBParameterGroup](API_DBParameterGroup.md) object

## Errors
<a name="API_CopyDBParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
A DB parameter group with the same name exists.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBParameterGroupQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB parameter groups.  
HTTP Status Code: 400

## Examples
<a name="API_CopyDBParameterGroup_Examples"></a>

### Example
<a name="API_CopyDBParameterGroup_Example_1"></a>

This example illustrates one usage of CopyDBParameterGroup.

#### Sample Request
<a name="API_CopyDBParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CopyDBParameterGroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceDBParameterGroupIdentifier=arn%3Aaws%3Ards%3Aus-west-2%3A815981987263%3pg%3Amy-remote-param-group
   &TargetDBParameterGroupIdentifier=new-local-param-group
   &TargetDBParameterGroupDescription=description
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request
   &X-Amz-Date=20140429T175351Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2
```

#### Sample Response
<a name="API_CopyDBParameterGroup_Example_1_Response"></a>

```
<CopyDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CopyDBParameterGroupResult>
    <DBParameterGroup>
      <DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily>
      <Description>description</Description>
      <DBParameterGroupName>new-local-param-group</DBParameterGroupName>
    </DBParameterGroup>
  </CopyDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId>
  </ResponseMetadata>
</CopyDBParameterGroupResponse>
```

## See Also
<a name="API_CopyDBParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CopyDBParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CopyDBParameterGroup) 

# CopyDBSnapshot
<a name="API_CopyDBSnapshot"></a>

Copies the specified DB snapshot. The source DB snapshot must be in the `available` state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the `CopyDBSnapshot` operation is the destination AWS Region for the DB snapshot copy.

This command doesn't apply to RDS Custom.

For more information about copying snapshots, see [Copying a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_CopyDBSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBSnapshotIdentifier **   
The identifier for the source DB snapshot.  
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify `rds:mysql-instance1-snapshot-20130805`.  
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.  
If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different AWS Region. For example, you might specify `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`.  
Constraints:  
+ Must specify a valid source snapshot in the "available" state.
Example: `rds:mydb-2012-04-02-00-01`   
Example: `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`   
Type: String  
Required: Yes

 ** TargetDBSnapshotIdentifier **   
The identifier for the copy of the snapshot.  
Constraints:  
+ Can't be null, empty, or blank
+ Must contain from 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-db-snapshot`   
Type: String  
Required: Yes

 ** CopyOptionGroup **   
Specifies whether to copy the DB option group associated with the source DB snapshot to the target AWS account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.  
Type: Boolean  
Required: No

 ** CopyTags **   
Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.  
Type: Boolean  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same AWS KMS key as the source DB snapshot.  
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.  
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.  
If you copy an encrypted snapshot to a different AWS Region, then you must specify an AWS KMS key identifier for the destination AWS Region. KMS keys are specific to the AWS Region that they are created in, and you can't use KMS keys from one AWS Region in another AWS Region.  
Type: String  
Required: No

 ** OptionGroupName **   
The name of an option group to associate with the copy of the snapshot.  
Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see [Option group considerations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** PreSignedUrl **   
When you are copying a snapshot from one AWS GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the `CopyDBSnapshot` API operation in the source AWS Region that contains the source DB snapshot to copy.  
This setting applies only to AWS GovCloud (US) Regions. It's ignored in other AWS Regions.  
You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify `PreSignedUrl` when you are copying an encrypted DB snapshot in the same AWS Region.  
The presigned URL must be a valid request for the `CopyDBClusterSnapshot` API operation that can run in the source AWS Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:  
+  `DestinationRegion` - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the `CopyDBSnapshot` operation is called that contains this presigned URL.

  For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the `CopyDBSnapshot` operation in the us-east-1 AWS Region and provide a presigned URL that contains a call to the `CopyDBSnapshot` operation in the us-west-2 AWS Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 AWS Region.
+  `KmsKeyId` - The AWS KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the `CopyDBSnapshot` operation that is called in the destination AWS Region, and the operation contained in the presigned URL.
+  `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the encrypted 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 snapshot from the us-west-2 AWS Region, then your `SourceDBSnapshotIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`.
To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).  
If you are using an AWS SDK tool or the AWS CLI, you can specify `SourceRegion` (or `--source-region` for the AWS CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source AWS Region.
Type: String  
Required: No

 ** SnapshotAvailabilityZone **   
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.  
Type: String  
Required: No

 ** SnapshotTarget **   
Configures the location where RDS will store copied snapshots.  
Valid Values:  
+  `local` (Dedicated Local Zone)
+  `outposts` (AWS Outposts)
+  `region` (AWS Region)
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TargetCustomAvailabilityZone **   
The external custom Availability Zone (CAZ) identifier for the target CAZ.  
Example: `rds-caz-aiqhTgQv`.  
Type: String  
Required: No

## Response Elements
<a name="API_CopyDBSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshot **   
Contains the details of an Amazon RDS DB snapshot.  
This data type is used as a response element in the `DescribeDBSnapshots` action.  
Type: [DBSnapshot](API_DBSnapshot.md) object

## Errors
<a name="API_CopyDBSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CustomAvailabilityZoneNotFound **   
 `CustomAvailabilityZoneId` doesn't refer to an existing custom Availability Zone identifier.  
HTTP Status Code: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` is already used by an existing snapshot.  
HTTP Status Code: 400

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_CopyDBSnapshot_Examples"></a>

### Example
<a name="API_CopyDBSnapshot_Example_1"></a>

This example illustrates one usage of CopyDBSnapshot.

#### Sample Request
<a name="API_CopyDBSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CopyDBSnapshot
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceDBSnapshotIdentifier=arn%3Aaws%3Ards%3Aus-east-1%3A123456789012%3Asnapshot%3Ards%3Amysqldb-2021-04-27-08-16
   &TargetDBSnapshotIdentifier=mysqldb-copy
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request
   &X-Amz-Date=20210629T175351Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2
```

#### Sample Response
<a name="API_CopyDBSnapshot_Example_1_Response"></a>

```
<CopyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CopyDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>available</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.44</EngineVersion>
      <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysqldb-copy</DBSnapshotIdentifier>
      <SnapshotCreateTime>2021-05-11T06:02:03.422Z</SnapshotCreateTime>
      <OriginalSnapshotCreateTime>2021-04-27T08:16:05.356Z</OriginalSnapshotCreateTime>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2021-04-21T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>admin</MasterUsername>
    </DBSnapshot>
  </CopyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId>
  </ResponseMetadata>
</CopyDBSnapshotResponse>
```

## See Also
<a name="API_CopyDBSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CopyDBSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CopyDBSnapshot) 

# CopyOptionGroup
<a name="API_CopyOptionGroup"></a>

Copies the specified option group.

## Request Parameters
<a name="API_CopyOptionGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceOptionGroupIdentifier **   
The identifier for the source option group.  
Constraints:  
+ Must specify a valid option group.
Type: String  
Required: Yes

 ** TargetOptionGroupDescription **   
The description for the copied option group.  
Type: String  
Required: Yes

 ** TargetOptionGroupIdentifier **   
The identifier for the copied option group.  
Constraints:  
+ Can't be null, empty, or blank
+ Must contain from 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-option-group`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CopyOptionGroup_ResponseElements"></a>

The following element is returned by the service.

 ** OptionGroup **   
  
Type: [OptionGroup](API_OptionGroup.md) object

## Errors
<a name="API_CopyOptionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OptionGroupAlreadyExistsFault **   
The option group you are trying to create already exists.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** OptionGroupQuotaExceededFault **   
The quota of 20 option groups was exceeded for this AWS account.  
HTTP Status Code: 400

## Examples
<a name="API_CopyOptionGroup_Examples"></a>

### Example
<a name="API_CopyOptionGroup_Example_1"></a>

This example illustrates one usage of CopyOptionGroup.

#### Sample Request
<a name="API_CopyOptionGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CopyOptionGroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceOptionGroupIdentifier=my-option-group
   &TargetOptionGroupDescription=New%20option%20group
   &TargetOptionGroupIdentifier=new-option-group
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request
   &X-Amz-Date=20140429T175351Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2
```

#### Sample Response
<a name="API_CopyOptionGroup_Example_1_Response"></a>

```
<CopyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CopyOptionGroupResult>
    <OptionGroup>
      <OptionGroupName>new-option-group</OptionGroupName>
      <MajorEngineVersion>5.6</MajorEngineVersion>
      <AllowsVpcAndNonVpcInstanceMemberships>false</AllowsVpcAndNonVpcInstanceMemberships>
      <EngineName>mysql</EngineName>
      <OptionGroupDescription>description</OptionGroupDescription>
      <Options>
        <Option>
          <Port>11211</Port>
          <OptionName>MEMCACHED</OptionName>
          <OptionDescription>Innodb Memcached for MySQL</OptionDescription>
          <Persistent>false</Persistent>
          <OptionSettings>
            <OptionSetting>
              <DataType>BOOLEAN</DataType>
              <IsModifiable>true</IsModifiable>
              <IsCollection>false</IsCollection>
              <Description>If enabled when there is no more memory to store items, memcached returns an error rather than evicting items.</Description>
              <Name>ERROR_ON_MEMORY_EXHAUSTED</Name>
              <Value>0</Value>
              <ApplyType>STATIC</ApplyType>
              <AllowedValues>0,1</AllowedValues>
              <DefaultValue>0</DefaultValue>
            </OptionSetting>
            <OptionSetting>
              <DataType>INTEGER</DataType>
              <IsModifiable>true</IsModifiable>
              <IsCollection>false</IsCollection>
              <Description>The backlog queue configures how many network connections can be waiting to be processed by memcached</Description>
              <Name>BACKLOG_QUEUE_LIMIT</Name>
              <Value>1024</Value>
              <ApplyType>STATIC</ApplyType>
              <AllowedValues>1-2048</AllowedValues>
              <DefaultValue>1024</DefaultValue>
            </OptionSetting>
          </OptionSettings>
          <VpcSecurityGroupMemberships/>
          <Permanent>false</Permanent>
          <DBSecurityGroupMemberships>
            <DBSecurityGroup>
              <Status>authorized</Status>
              <DBSecurityGroupName>default</DBSecurityGroupName>
            </DBSecurityGroup>
          </DBSecurityGroupMemberships>
        </Option>
      </Options>
    </OptionGroup>
  </CopyOptionGroupResult>
  <ResponseMetadata>
    <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId>
  </ResponseMetadata>
</CopyOptionGroupResponse>
```

## See Also
<a name="API_CopyOptionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CopyOptionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CopyOptionGroup) 

# CreateBlueGreenDeployment
<a name="API_CreateBlueGreenDeployment"></a>

Creates 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 current production environment.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [ Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_CreateBlueGreenDeployment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BlueGreenDeploymentName **   
The name of the blue/green deployment.  
Constraints:  
+ Can't be the same as an existing blue/green deployment name in the same account and AWS Region.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** Source **   
The Amazon Resource Name (ARN) of the source production database.  
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the blue/green deployment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TargetAllocatedStorage **   
The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.  
This setting doesn't apply to Amazon Aurora blue/green deployments.  
Type: Integer  
Required: No

 ** TargetDBClusterParameterGroupName **   
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.  
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\.\.)[0-9A-Za-z-.]*[^-]`   
Required: No

 ** TargetDBInstanceClass **   
Specify the DB instance class for the databases in the green environment.  
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 20.  
Pattern: `db\.[0-9a-z]{2,6}\.[0-9a-z]{4,9}`   
Required: No

 ** TargetDBParameterGroupName **   
The DB parameter group associated with the DB instance in the green environment.  
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\.\.)[0-9A-Za-z-.]*[^-]`   
Required: No

 ** TargetEngineVersion **   
The engine version of the database in the green environment.  
Specify the engine version to upgrade to in the green environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9A-Za-z-_.]+`   
Required: No

 ** TargetIops **   
The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see [Amazon RDS DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora blue/green deployments.  
Type: Integer  
Required: No

 ** TargetStorageThroughput **   
The storage throughput value for the green DB instance.  
This setting applies only to the `gp3` storage type.  
This setting doesn't apply to Amazon Aurora blue/green deployments.  
Type: Integer  
Required: No

 ** TargetStorageType **   
The storage type to associate with the green DB instance.  
Valid Values: `gp2 | gp3 | io1 | io2`   
This setting doesn't apply to Amazon Aurora blue/green deployments.  
Type: String  
Required: No

 ** UpgradeTargetStorageConfig **   
Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see [Upgrading the storage file system for a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem).  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CreateBlueGreenDeployment_ResponseElements"></a>

The following element is returned by the service.

 ** BlueGreenDeployment **   
Details about a blue/green deployment.  
For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.  
Type: [BlueGreenDeployment](API_BlueGreenDeployment.md) object

## Errors
<a name="API_CreateBlueGreenDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentAlreadyExistsFault **   
A blue/green deployment with the specified name already exists.  
HTTP Status Code: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** SourceClusterNotSupportedFault **   
The source DB cluster isn't supported for a blue/green deployment.  
HTTP Status Code: 400

 ** SourceDatabaseNotSupportedFault **   
The source DB instance isn't supported for a blue/green deployment.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

## Examples
<a name="API_CreateBlueGreenDeployment_Examples"></a>

### Example
<a name="API_CreateBlueGreenDeployment_Example_1"></a>

This example illustrates one usage of CreateBlueGreenDeployment.

#### Sample Request
<a name="API_CreateBlueGreenDeployment_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=CreateBlueGreenDeployment
   &BlueGreenDeploymentName=my-blue-green-deployment
   &Source=arn%3Aaws%3Ards%3Aus-west-2%3A123456789012%3Adb%3Adatabase-1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-west-2/rds/aws4_request
   &X-Amz-Date=20230110T005253Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_CreateBlueGreenDeployment_Example_1_Response"></a>

```
<CreateBlueGreenDeploymentResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateBlueGreenDeploymentResult>
    <BlueGreenDeployment>
      <TagList/>
      <BlueGreenDeploymentName>my-blue-green-deployment</BlueGreenDeploymentName>
      <CreateTime>2023-01-10T18:42:09.330Z</CreateTime>
      <SwitchoverDetails>
        <member>
          <SourceMember>arn:aws:rds:us-west-2:123456789012:db:database-1</SourceMember>
        </member>
      </SwitchoverDetails>
      <Source>arn:aws:rds:us-west-2:123456789012:db:database-1</Source>
      <BlueGreenDeploymentIdentifier>bgd-mdoyy2mn7vbkhhgg</BlueGreenDeploymentIdentifier>
      <Tasks>
        <member>
          <Name>CREATING_READ_REPLICA_OF_SOURCE</Name>
          <Status>PENDING</Status>
        </member>
        <member>
          <Name>CONFIGURE_BACKUPS</Name>
          <Status>PENDING</Status>
        </member>
      </Tasks>
      <Status>PROVISIONING</Status>
    </BlueGreenDeployment>
  </CreateBlueGreenDeploymentResult>
  <ResponseMetadata>
    <RequestId>03b87d54-b780-4055-b44d-4a2a129bc8c2</RequestId>
  </ResponseMetadata>
</CreateBlueGreenDeploymentResponse>
```

## See Also
<a name="API_CreateBlueGreenDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateBlueGreenDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateBlueGreenDeployment) 

# CreateCustomDBEngineVersion
<a name="API_CreateCustomDBEngineVersion"></a>

Creates a custom DB engine version (CEV).

## Request Parameters
<a name="API_CreateCustomDBEngineVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The database engine.  
RDS Custom for Oracle supports the following values:  
+  `custom-oracle-ee` 
+  `custom-oracle-ee-cdb` 
+  `custom-oracle-se2` 
+  `custom-oracle-se2-cdb` 
RDS Custom for SQL Server supports the following values:  
+  `custom-sqlserver-ee` 
+  `custom-sqlserver-se` 
+  `ccustom-sqlserver-web` 
+  `custom-sqlserver-dev` 
RDS for SQL Server supports only `sqlserver-dev-ee`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[A-Za-z0-9-]{1,35}`   
Required: Yes

 ** EngineVersion **   
The name of your custom engine version (CEV).  
For RDS Custom for Oracle, the name format is `19.*customized_string*`. For example, a valid CEV name is `19.my_cev1`.  
For RDS for SQL Server and RDS Custom for SQL Server, the name format is `major engine_version*.*minor_engine_version*.*customized_string*`. For example, a valid CEV name is `16.00.4215.2.my_cev1`.  
The CEV name is unique per customer per AWS Regions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `[a-z0-9_.-]{1,60}`   
Required: Yes

 **DatabaseInstallationFiles.member.N**   
The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS.  
Type: Array of strings  
Required: No

 ** DatabaseInstallationFilesS3BucketName **   
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*`   
Required: No

 ** DatabaseInstallationFilesS3Prefix **   
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** Description **   
An optional description of your CEV.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** ImageId **   
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the [DescribeDBEngineVersions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html) operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** KMSKeyId **   
The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.  
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [ Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the * AWS Key Management Service Developer Guide*.  
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9_:\-\/]+`   
Required: No

 ** Manifest **   
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.  
The following JSON fields are valid:    
MediaImportTemplateVersion  
Version of the CEV manifest. The date is in the format `YYYY-MM-DD`.  
databaseInstallationFileNames  
Ordered list of installation files for the CEV.  
opatchFileNames  
Ordered list of OPatch installers used for the Oracle DB engine.  
psuRuPatchFileNames  
The PSU and RU patches for this CEV.  
OtherPatchFileNames  
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see [ Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51000.  
Pattern: `[\s\S]*`   
Required: No

 ** SourceCustomDbEngineVersionIdentifier **   
The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either `Source` or `UseAwsProvidedLatestImage`. You can't specify a different JSON manifest when you specify `SourceCustomDbEngineVersionIdentifier`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*`   
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** UseAwsProvidedLatestImage **   
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify `UseAwsProvidedLatestImage`, you can't also specify `ImageId`.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CreateCustomDBEngineVersion_ResponseElements"></a>

The following elements are returned by the service.

 ** CreateTime **   
The creation time of the DB engine version.  
Type: Timestamp

 ** CustomDBEngineVersionManifest **   
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see [JSON fields in the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) in the *Amazon RDS User Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51000.  
Pattern: `[\s\S]*` 

 **DatabaseInstallationFiles.member.N**   
The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. Required for `sqlserver-dev-ee`.  
Type: Array of strings

 ** DatabaseInstallationFilesS3BucketName **   
The name of the Amazon S3 bucket that contains your database installation files.  
Type: String

 ** DatabaseInstallationFilesS3Prefix **   
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.  
Type: String

 ** DBEngineDescription **   
The description of the database engine.  
Type: String

 ** DBEngineMediaType **   
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.  
Type: String

 ** DBEngineVersionArn **   
The ARN of the custom engine version.  
Type: String

 ** DBEngineVersionDescription **   
The description of the database engine version.  
Type: String

 ** DBParameterGroupFamily **   
The name of the DB parameter group family for the database engine.  
Type: String

 ** DefaultCharacterSet **   
The default character set for new instances of this engine version, if the `CharacterSetName` parameter of the CreateDBInstance API isn't specified.  
Type: [CharacterSet](API_CharacterSet.md) object

 ** Engine **   
The name of the database engine.  
Type: String

 ** EngineVersion **   
The version number of the database engine.  
Type: String

 **ExportableLogTypes.member.N**   
The types of logs that the database engine has available for export to CloudWatch Logs.  
Type: Array of strings

 ** FailureReason **   
The reason that the custom engine version creation for `sqlserver-dev-ee` failed with an `incompatible-installation-media` status.  
Type: String

 ** Image **   
The EC2 image  
Type: [CustomDBEngineVersionAMI](API_CustomDBEngineVersionAMI.md) object

 ** KMSKeyId **   
The AWS KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.  
Type: String

 ** MajorEngineVersion **   
The major engine version of the CEV.  
Type: String

 ** ServerlessV2FeaturesSupport **   
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.   
Type: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) object

 ** Status **   
The status of the DB engine version, either `available` or `deprecated`.  
Type: String

 **SupportedCACertificateIdentifiers.member.N**   
A list of the supported CA certificate identifiers.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: Array of strings

 **SupportedCharacterSets.CharacterSet.N**   
A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedEngineModes.member.N**   
A list of the supported DB engine modes.  
Type: Array of strings

 **SupportedFeatureNames.member.N**   
A list of features supported by the DB engine.  
The supported features vary by DB engine and DB engine version.  
To determine the supported features for a specific DB engine and DB engine version using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>`   
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --engine-version 13.3`   
The supported features are listed under `SupportedFeatureNames` in the output.  
Type: Array of strings

 **SupportedNcharCharacterSets.CharacterSet.N**   
A list of the character sets supported by the Oracle DB engine for the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedTimezones.Timezone.N**   
A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action.  
Type: Array of [Timezone](API_Timezone.md) objects

 ** SupportsBabelfish **   
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.  
Type: Boolean

 ** SupportsCertificateRotationWithoutRestart **   
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.  
Type: Boolean

 ** SupportsGlobalDatabases **   
Indicates whether you can use Aurora global databases with a specific DB engine version.  
Type: Boolean

 ** SupportsIntegrations **   
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.  
Type: Boolean

 ** SupportsLimitlessDatabase **   
Indicates whether the DB engine version supports Aurora Limitless Database.  
Type: Boolean

 ** SupportsLocalWriteForwarding **   
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.  
Valid for: Aurora DB clusters only  
Type: Boolean

 ** SupportsLogExportsToCloudwatchLogs **   
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.  
Type: Boolean

 ** SupportsParallelQuery **   
Indicates whether you can use Aurora parallel query with a specific DB engine version.  
Type: Boolean

 ** SupportsReadReplica **   
Indicates whether the database engine version supports read replicas.  
Type: Boolean

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 **ValidUpgradeTarget.UpgradeTarget.N**   
A list of engine versions that this database engine version can be upgraded to.  
Type: Array of [UpgradeTarget](API_UpgradeTarget.md) objects

## Errors
<a name="API_CreateCustomDBEngineVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CreateCustomDBEngineVersionFault **   
An error occurred while trying to create the CEV.  
HTTP Status Code: 400

 ** CustomDBEngineVersionAlreadyExistsFault **   
A CEV with the specified name already exists.  
HTTP Status Code: 400

 ** CustomDBEngineVersionNotFoundFault **   
The specified CEV was not found.  
HTTP Status Code: 404

 ** CustomDBEngineVersionQuotaExceededFault **   
You have exceeded your CEV quota.  
HTTP Status Code: 400

 ** Ec2ImagePropertiesNotSupportedFault **   
The AMI configuration prerequisite has not been met.  
HTTP Status Code: 400

 ** InvalidCustomDBEngineVersionStateFault **   
You can't delete the CEV.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCustomDBEngineVersion_Examples"></a>

### Example
<a name="API_CreateCustomDBEngineVersion_Example_1"></a>

This example illustrates one usage of CreateCustomDBEngineVersion.

#### Sample Request
<a name="API_CreateCustomDBEngineVersion_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Engine=custom-oracle-ee
    &EngineVersion=19.cev1
    &DatabaseInstallationFilesS3BucketName=1-custom-installation-files
    &DatabaseInstallationFilesS3Prefix=123456789012/cev1
    &KMSKeyId=12ab3c4d-5678-90e1-2fg3-45h6ijklmnops
    &Description=cev%20description
    &Manifest=%7B%22mediaImportTemplateVersion%22%3A%222020-08--14%22%2C%22databaseInstallationFileNames%22%3A%5B%22V982063-01.zip%22%5D%2C%22opatchFileNames%22%3A%5B%22p6880880_190000_Linux-x86-64.zip%22%5D%2C%22psuRuPatchFileNames%22%3A%5B%22p31720396_190000_Linux-x86-64.zip%22%2C%22p29213893_199000DBRU_Generic.zip%22%2C%22p28730253_190000_Linux-x86-64.zip%22%2C%22p29374604_199000DBRU_Linux-x86-64.zip%22%2C%22p28852325_190000_Linux-x86-64.zip%22%2C%22p29997937_190000_Linux-x86-64.zip%22%2C%22p31335037_190000_Linux-x86-64.zip%22%2C%22p31335142_190000_Generic.zip%22%5D%7D
```

#### Sample Response
<a name="API_CreateCustomDBEngineVersion_Example_1_Response"></a>

```
<CreateCustomDBEngineVersionResponse xmlns="http://rds.amazonaws.com/doc/1999-01-01/">
  <CreateCustomDBEngineVersionResult>
    <DatabaseInstallationFilesS3Prefix>123456789012/cev1</DatabaseInstallationFilesS3Prefix>
    <MajorEngineVersion>19</MajorEngineVersion>
    <DBEngineVersionArn>arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee/19.cev1/123ab45c-abc1-1234-1234-123a45b12345</DBEngineVersionArn>
    <DBEngineVersionDescription>cev description</DBEngineVersionDescription>
    <SupportsGlobalDatabases>false</SupportsGlobalDatabases>
    <SupportsParallelQuery>false</SupportsParallelQuery>
    <Engine>custom-oracle-ee</Engine>
    <KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/12ab3c4d-1234-12a3-1aa2-12a3bcdefghi</KMSKeyId>
    <EngineVersion>19.cev1</EngineVersion>
    <SupportsReadReplica>false</SupportsReadReplica>
    <SupportsCluster>false</SupportsCluster>
    <CreateTime>2021-10-13T22:15:11.157Z</CreateTime>
    <DatabaseInstallationFilesS3BucketName>1-custom-installation-files</DatabaseInstallationFilesS3BucketName>
    <SupportsLogExportsToCloudwatchLogs>false</SupportsLogExportsToCloudwatchLogs>
    <AMIs>
      <member>
        <Id>ami-123a4b5c678901d23</Id>
        <Status>validating</Status>
      </member>
    </AMIs>
    <DBEngineDescription>Oracle Database server EE for RDS Custom</DBEngineDescription>
    <Status>creating</Status>
  </CreateCustomDBEngineVersionResult>
  <ResponseMetadata>
    <RequestId>897d9e88-057a-4695-812c-29cd36ec89d5</RequestId>
  </ResponseMetadata>
</CreateCustomDBEngineVersionResponse>
```

## See Also
<a name="API_CreateCustomDBEngineVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateCustomDBEngineVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateCustomDBEngineVersion) 

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

Creates 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

You can use the `ReplicationSourceIdentifier` parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see [What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

You can also use the `ReplicationSourceIdentifier` parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

You can use the `WithExpressConfiguration` parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API. 

## Request Parameters
<a name="API_CreateDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The identifier for this DB cluster. This parameter is stored as a lowercase string.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster1`   
Type: String  
Required: Yes

 ** Engine **   
The database engine to use for this DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `mysql` 
+  `postgres` 
+  `neptune` - For information about using Amazon Neptune, see the [https://docs.aws.amazon.com/neptune/latest/userguide/intro.html](https://docs.aws.amazon.com/neptune/latest/userguide/intro.html).
Type: String  
Required: Yes

 ** AllocatedStorage **   
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.  
Valid for Cluster Type: Multi-AZ DB clusters only  
This setting is required to create a Multi-AZ DB cluster.  
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 **AvailabilityZones.AvailabilityZone.N**   
A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.  
For the first three DB instances that you create, RDS distributes each DB instance to a different AZ that you specify. For additional DB instances that you create, RDS randomly distributes them to the AZs that you specified. For example, if you create a DB cluster with one writer instance and three reader instances, RDS might distribute the writer instance to AZ 1, the first reader instance to AZ 2, the second reader instance to AZ 3, and the third reader instance to either AZ 1, AZ 2, or AZ 3.   
For more information, see [Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones) and [High availability for Aurora DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Concepts.AuroraHighAvailability.Instances) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters only  
Constraints:  
+ Can't specify more than three AZs.
Type: Array of strings  
Required: No

 ** BacktrackWindow **   
The target backtrack window, in seconds. To disable backtracking, set this value to `0`.  
Valid for Cluster Type: Aurora MySQL DB clusters only  
Default: `0`   
Constraints:  
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Type: Long  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Default: `1`   
Constraints:  
+ Must be a value from 1 to 35.
Type: Integer  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB cluster's server certificate.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Multi-AZ DB clusters  
Type: String  
Required: No

 ** CharacterSetName **   
The name of the character set (`CharacterSet`) to associate the DB cluster with.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** ClusterScalabilityType **   
Specifies the scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation.  
Valid for: Aurora DB clusters only  
You can't modify this setting after you create the DB cluster.
Type: String  
Valid Values: `standard | limitless`   
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** DatabaseInsightsMode **   
The mode of Database Insights to enable for the DB cluster.  
If you set this value to `advanced`, you must also set the `PerformanceInsightsEnabled` parameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DatabaseName **   
The name for your database of up to 64 alphanumeric characters. A database named `postgres` is always created. If this parameter is specified, an additional database with this name is created.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DBClusterInstanceClass **   
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines.  
For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.  
This setting is required to create a Multi-AZ DB cluster.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Type: String  
Required: No

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ If supplied, must match the name of an existing DB cluster parameter group.
Type: String  
Required: No

 ** DBSubnetGroupName **   
A DB subnet group to associate with this DB cluster.  
This setting is required to create a Multi-AZ DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must match the name of an existing DB subnet group.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DBSystemId **   
Reserved for future use.  
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to create the DB cluster in.  
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.  
For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of log types that need to be enabled for exporting to CloudWatch Logs.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
The following values are valid for each DB engine:  
+ Aurora MySQL - `audit | error | general | instance | slowquery | iam-db-auth-error` 
+ Aurora PostgreSQL - `instance | postgresql | iam-db-auth-error` 
+ RDS for MySQL - `error | general | slowquery | iam-db-auth-error` 
+ RDS for PostgreSQL - `postgresql | upgrade | iam-db-auth-error` 
For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Type: Array of strings  
Required: No

 ** EnableGlobalWriteForwarding **   
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.  
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.  
Valid for Cluster Type: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnableHttpEndpoint **   
Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.  
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.  
For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide* or [IAM database authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EnableLimitlessDatabase **   
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.  
Valid for: Aurora DB clusters only  
This setting is no longer used. Instead use the `ClusterScalabilityType` setting.
Type: Boolean  
Required: No

 ** EnableLocalWriteForwarding **   
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.  
Valid for: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to turn on Performance Insights for the DB cluster.  
For more information, see [ Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB cluster.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:  
+ Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* 
+ Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* 
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineMode **   
The DB engine mode of the DB cluster, either `provisioned` or `serverless`.  
The `serverless` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the `provisioned` engine mode.  
For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:  
+  [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) 
+  [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) 
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to use.  
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`   
You can supply either `5.7` or `8.0` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.  
To list all of the available engine versions for Aurora PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for MySQL, use the following command:  
 `aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`   
For information about a specific engine, see the following topics:  
+ Aurora MySQL - see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.
+ Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.
+ RDS for MySQL - see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.
+ RDS for PostgreSQL - see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** GlobalClusterIdentifier **   
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.  
For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.  
This setting is required to create a Multi-AZ DB cluster.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Constraints:  
+ Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB cluster.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
When a KMS key isn't specified in `KmsKeyId`:  
+ If `ReplicationSourceIdentifier` identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
+ If the `StorageEncrypted` parameter is enabled and `ReplicationSourceIdentifier` isn't specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set `KmsKeyId` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*   
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUserAuthenticationType **   
Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.  
You can specify one of the following values:  
+  `password` - Use standard database authentication with a password.
+  `iam-db-auth` - Use IAM database authentication for the master user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.  
Type: String  
Valid Values: `password | iam-db-auth`   
Required: No

 ** MasterUsername **   
The name of the master user for the DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
Type: String  
Required: No

 ** MasterUserPassword **   
The password for the master database user.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must contain from 8 to 41 characters.
+ Can contain any printable ASCII character except "/", """, or "@".
+ Can't be specified if `ManageMasterUserPassword` is turned on.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB cluster.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.  
If `MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB cluster.  
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*   
Valid for Cluster Type: Aurora DB clusters only  
Valid Values: `IPV4 | DUAL`   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to associate the DB cluster with.  
DB clusters are associated with a default option group that can't be modified.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS issues an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the instances in the DB cluster accept connections.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `1150-65535`   
Default:  
+ RDS for MySQL and Aurora MySQL - `3306` 
+ RDS for PostgreSQL and Aurora PostgreSQL - `5432` 
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To view the time blocks available, see [ Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide*.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The weekly time range during which system maintenance can occur.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide*.  
Constraints:  
+ Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
+ Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
+ Must be in Universal Coordinated Time (UTC).
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreSignedUrl **   
When you are replicating a DB cluster from one AWS GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the `CreateDBCluster` operation to be called in the source AWS Region where the DB cluster is replicated from. Specify `PreSignedUrl` only when you are performing cross-Region replication from an encrypted DB cluster.  
The presigned URL must be a valid request for the `CreateDBCluster` API operation that can run in the source AWS Region that contains the encrypted DB cluster to copy.  
The presigned URL request must contain the following parameter values:  
+  `KmsKeyId` - The AWS KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the `CreateDBCluster` operation that is called in the destination AWS Region, and the operation contained in the presigned URL.
+  `DestinationRegion` - The name of the AWS Region that Aurora read replica will be created in.
+  `ReplicationSourceIdentifier` - The DB cluster identifier for the encrypted DB cluster 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 from the us-west-2 AWS Region, then your `ReplicationSourceIdentifier` would look like Example: `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`.
To learn how to generate a Signature Version 4 signed request, see [ Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and [ Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).  
If you are using an AWS SDK tool or the AWS CLI, you can specify `SourceRegion` (or `--source-region` for the AWS CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source AWS Region.
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB cluster is publicly accessible.  
Valid for Cluster Type: Multi-AZ DB clusters only  
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.  
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.  
The default behavior when `PubliclyAccessible` is not specified depends on whether a `DBSubnetGroup` is specified.  
If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to `true`.  
If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to `false` unless the value of `DBSubnetGroup` is `default`, in which case `PubliclyAccessible` defaults to `true`.  
If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup` is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.  
Type: Boolean  
Required: No

 ** RdsCustomClusterConfiguration **   
Reserved for future use.  
Type: [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) object  
Required: No

 ** ReplicationSourceIdentifier **   
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** ScalingConfiguration **   
For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.  
Valid for Cluster Type: Aurora DB clusters only  
Type: [ScalingConfiguration](API_ScalingConfiguration.md) object  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.  
For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** StorageEncrypted **   
Specifies whether the DB cluster is encrypted.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** StorageType **   
The storage type to associate with the DB cluster.  
For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).  
This setting is required to create a Multi-AZ DB cluster.  
When specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values:  
+ Aurora DB clusters - `aurora | aurora-iopt1` 
+ Multi-AZ DB clusters - `io1 | io2 | gp3` 
Default:  
+ Aurora DB clusters - `aurora` 
+ Multi-AZ DB clusters - `io1` 
When you create an Aurora DB cluster with the storage type set to `aurora-iopt1`, the storage type is returned in the response. The storage type isn't returned when you set it to `aurora`.
Type: String  
Required: No

 **Tags.Tag.N**   
Tags to assign to the DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB cluster.  
Valid Values:   
+  `cluster-auto-backup` - The DB cluster's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of EC2 VPC security groups to associate with this DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

 ** WithExpressConfiguration **   
Specifies to create an Aurora DB Cluster with express configuration in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API.   
Valid for Cluster Type: Aurora DB clusters  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CreateDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_CreateDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
The user already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InsufficientStorageClusterCapacity **   
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupFault **   
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupStateFault **   
The DB subnet group cannot be deleted because it's in use.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBCluster_Examples"></a>

### Creating an Aurora DB cluster
<a name="API_CreateDBCluster_Example_1"></a>

This example illustrates one usage of CreateDBCluster.

#### Sample Request
<a name="API_CreateDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=CreateDBCluster
    &DBClusterIdentifier=sample-cluster
    &Engine=aurora
    &MasterUserPassword=<password>
    &MasterUsername=myawsuser
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150927/us-east-1/rds/aws4_request
    &X-Amz-Date=20220927T164851Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=6a8f4bd6a98f649c75ea04a6b3929ecc75ac09739588391cd7250f5280e716db
```

#### Sample Response
<a name="API_CreateDBCluster_Example_1_Response"></a>

```
<CreateDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBClusterResult>
    <DBCluster>
      <Port>3306</Port>
      <Engine>aurora</Engine>
      <Status>creating</Status>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <Status>active</Status>
          <VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <DBSubnetGroup>default</DBSubnetGroup>
      <EngineVersion>5.7</EngineVersion>
      <Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <AvailabilityZones>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <AvailabilityZone>us-east-1e</AvailabilityZone>
      </AvailabilityZones>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <PreferredBackupWindow>04:22-04:52</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow>
      <DBClusterMembers/>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBCluster>
  </CreateDBClusterResult>
  <ResponseMetadata>
    <RequestId>46d2b228-7681-11e5-3e8b-9b2c0d5d51a9</RequestId>
  </ResponseMetadata>
</CreateDBClusterResponse>
```

### Creating a Multi-AZ DB cluster
<a name="API_CreateDBCluster_Example_2"></a>

This example illustrates one usage of CreateDBCluster.

#### Sample Request
<a name="API_CreateDBCluster_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=CreateDBCluster
    &AvailabilityZones.AvailabilityZone.1=us-west-2a
    &BackupRetentionPeriod=2
    &DatabaseName=mydb
    &DBClusterIdentifier=my-multi-az-cluster
    &DBClusterParameterGroupName=my-multi-az-cpg
    &VpcSecurityGroupIds.VpcSecurityGroupId.1=sg-6921cc28
    &DBSubnetGroupName=mysubnet1
    &Engine=mysql
    &EngineVersion=8.0.26
    &Port=3306
    &MasterUsername=admin
    &MasterUserPassword=<password>
    &PreferredBackupWindow=11:34-12:04
    &PreferredMaintenanceWindow=sat:07:05-sat:07:35
    &StorageEncrypted=true
    &KmsKeyId=123EXAMPLE-abcd-4567-efgEXAMPLE
    &EngineMode=provisioned
    &DeletionProtection=false
    &EnableHttpEndpoint=false
    &CopyTagsToSnapshot=true
    &DBClusterInstanceClass=db.r6gd.large
    &AllocatedStorage=100
    &StorageType=io1
    &Iops=1000
    &PubliclyAccessible=true
    &AutoMinorVersionUpgrade=true
    &MonitoringInterval=30
    &MonitoringRoleArn=arn:aws:iam:123456789012:role/enhance-monitoring-role
    &EnablePerformanceInsights=true
    &PerformanceInsightsKMSKeyId=123EXAMPLE-abcd-4567-efgEXAMPLE
    &PerformanceInsightsRetentionPeriod=7
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20211026/us-west-2/rds/aws4_request
    &X-Amz-Date=20220927T203712Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=6a8f4bd6a98f649c75ea04a6b3929ecc75ac09739588391cd7250f5280e716db
```

#### Sample Response
<a name="API_CreateDBCluster_Example_2_Response"></a>

```
<CreateDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBClusterResult>
    <DBCluster>
      <CrossAccountClone>false</CrossAccountClone>
      <AllocatedStorage>100</AllocatedStorage>
      <DatabaseName>mydb</DatabaseName>
      <AssociatedRoles />
      <AvailabilityZones>
          <AvailabilityZone>us-west-2a</AvailabilityZone>
          <AvailabilityZone>us-west-2b</AvailabilityZone>
          <AvailabilityZone>us-west-2c</AvailabilityZone>
      </AvailabilityZones>
      <ReadReplicaIdentifiers />
      <Iops>1000</Iops>
      <PerformanceInsightsKMSKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</PerformanceInsightsKMSKeyId>
      <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod>
      <EngineVersion>8.0.mysql_aurora.3.01.0</EngineVersion>
      <MasterUsername>admin</MasterUsername>
      <DBClusterMembers>
          <DBClusterMember>
              <DBInstanceIdentifier>my-multi-az-cluster-3</DBInstanceIdentifier>
              <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
              <PromotionTier>1</PromotionTier>
              <IsClusterWriter>false</IsClusterWriter>
          </DBClusterMember>
          <DBClusterMember>
              <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier>
              <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
              <PromotionTier>1</PromotionTier>
              <IsClusterWriter>false</IsClusterWriter>
          </DBClusterMember>
          <DBClusterMember>
              <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier>
              <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
              <PromotionTier>1</PromotionTier>
              <IsClusterWriter>false</IsClusterWriter>
          </DBClusterMember>
      </DBClusterMembers>
      <HttpEndpointEnabled>false</HttpEndpointEnabled>
      <Port>3306</Port>
      <MonitoringInterval>30</MonitoringInterval>
      <BackupRetentionPeriod>2</BackupRetentionPeriod>
      <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId>
      <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier>
      <DbClusterResourceId>cluster-RCPGZXFNIHCTBQLDRJX6CP62VQ</DbClusterResourceId>
      <Status>creating</Status>
      <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow>
      <DeletionProtection>false</DeletionProtection>
      <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint>
      <EngineMode>provisioned</EngineMode>
      <Engine>mysql</Engine>
      <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint>
      <PubliclyAccessible>true</PubliclyAccessible>
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
      <ClusterCreateTime>2021-10-20T00:12:00.867Z</ClusterCreateTime>
      <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled>
      <MultiAZ>true</MultiAZ>
      <DomainMemberships />
      <MonitoringRoleArn>arn:aws:iam::123456789012:role/enhance-monitoring-role</MonitoringRoleArn>
      <StorageEncrypted>true</StorageEncrypted>
      <DBSubnetGroup>mysubnet1</DBSubnetGroup>
      <VpcSecurityGroups>
          <VpcSecurityGroupMembership>
              <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId>
              <Status>active</Status>
          </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <TagList />
      <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId>
      <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow>
      <DBClusterParameterGroup>my-multi-az-cpg</DBClusterParameterGroup>
      <StorageType>io1</StorageType>
      <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass>
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn>
    </DBCluster>
  </CreateDBClusterResult>
  <ResponseMetadata>
    <RequestId>4c11cdec-1dbb-452c-bfc0-7580e4ba91ce</RequestId>
  </ResponseMetadata>
</CreateDBClusterResponse>
```

### Creating an Aurora DB cluster With Express Configuration
<a name="API_CreateDBCluster_Example_3"></a>

This example illustrates one usage of CreateDBCluster.

#### Sample Request
<a name="API_CreateDBCluster_Example_3_Request"></a>

```
                    https://rds.us-east-1.amazonaws.com/
                    ?Action=CreateDBCluster
                    &DBClusterIdentifier=sample-cluster
                    &Engine=aurora-postgresql
                    &WithExpressConfiguration
                    &SignatureMethod=HmacSHA256
                    &SignatureVersion=4
                    &Version=2014-10-31
                    &X-Amz-Algorithm=AWS4-HMAC-SHA256
                    &X-Amz-Credential=AKIADQKE4SARGYLE/20150927/us-east-1/rds/aws4_request
                    &X-Amz-Date=20220927T164851Z
                    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
                    &X-Amz-Signature=6a8f4bd6a98f649c75ea04a6b3929ecc75ac09739588391cd7250f5280e716db
```

#### Sample Response
<a name="API_CreateDBCluster_Example_3_Response"></a>

```
                    <CreateDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
                    <CreateDBClusterResult>
                    <DBCluster>
                    <AllocatedStorage>1</AllocatedStorage>
                    <AvailabilityZones>
                    <AvailabilityZone>us-east-1c</AvailabilityZone>
                    <AvailabilityZone>us-east-1a</AvailabilityZone>
                    <AvailabilityZone>us-east-1b</AvailabilityZone>
                    </AvailabilityZones>
                    <BackupRetentionPeriod>7</BackupRetentionPeriod>
                    <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
                    <DBClusterParameterGroup>default.aurora-postgresql17</DBClusterParameterGroup>
                    <Status>creating</Status>
                    <MultiAZ>false</MultiAZ>
                    <Engine>aurora-postgresql</Engine>
                    <EngineVersion>17.7</EngineVersion>
                    <Port>5432</Port>
                    <MasterUsername>postgres</MasterUsername>
                    <PreferredBackupWindow>06:15-06:45</PreferredBackupWindow>
                    <PreferredMaintenanceWindow>sat:03:44-sat:04:14</PreferredMaintenanceWindow>
                    <ReadReplicaIdentifiers/>
                    <DBClusterMembers>
                    <DBClusterMember>
                    <DBInstanceIdentifier>sample-cluster-instance-1</DBInstanceIdentifier>
                    <IsClusterWriter>false</IsClusterWriter>
                    <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
                    <PromotionTier>1</PromotionTier>
                    </DBClusterMember>
                    </DBClusterMembers>
                    <VpcSecurityGroups/>
                    <StorageEncrypted>false</StorageEncrypted>
                    <DbClusterResourceId>cluster-OWV7DRHS2W7R4LXZRYNXCHZST4</DbClusterResourceId>
                    <DBClusterArn>arn:aws:rds:us-east-1:654654253058:cluster:sample-cluster</DBClusterArn>
                    <AssociatedRoles/>
                    <IAMDatabaseAuthenticationEnabled>true</IAMDatabaseAuthenticationEnabled>
                    <ClusterCreateTime>2026-01-10T22:14:02Z</ClusterCreateTime>
                    <EngineMode>provisioned</EngineMode>
                    <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
                    <DeletionProtection>false</DeletionProtection>
                    <HttpEndpointEnabled>false</HttpEndpointEnabled>
                    <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
                    <CrossAccountClone>false</CrossAccountClone>
                    <DomainMemberships/>
                    <TagList/>
                    <ServerlessV2ScalingConfiguration>
                    <MinCapacity>0.0</MinCapacity>
                    <MaxCapacity>16.0</MaxCapacity>
                    <SecondsUntilAutoPause>300</SecondsUntilAutoPause>
                    </ServerlessV2ScalingConfiguration>
                    <ServerlessV2PlatformVersion>3</ServerlessV2PlatformVersion>
                    <DatabaseInsightsMode>standard</DatabaseInsightsMode>
                    <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
                    <LocalWriteForwardingStatus>disabled</LocalWriteForwardingStatus>
                    <EngineLifecycleSupport>open-source-rds-extended-support</EngineLifecycleSupport>
                    </DBCluster>
                    </CreateDBClusterResult>
                    <ResponseMetadata>
                    <RequestId>46d2b228-7681-11e5-3e8b-9b2c0d5d51a9</RequestId>
                    </ResponseMetadata>
                    </CreateDBClusterResponse>
```

## See Also
<a name="API_CreateDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBCluster) 

# CreateDBClusterEndpoint
<a name="API_CreateDBClusterEndpoint"></a>

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

**Note**  
This action applies only to Aurora DB clusters.

## Request Parameters
<a name="API_CreateDBClusterEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterEndpointIdentifier **   
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 ** EndpointType **   
The type of the endpoint, one of: `READER`, `WRITER`, `ANY`.  
Type: String  
Required: Yes

 **ExcludedMembers.member.N**   
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.  
Type: Array of strings  
Required: No

 **StaticMembers.member.N**   
List of DB instance identifiers that are part of the custom endpoint group.  
Type: Array of strings  
Required: No

 **Tags.Tag.N**   
The tags to be assigned to the Amazon RDS resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBClusterEndpoint_ResponseElements"></a>

The following elements are returned by the service.

 ** CustomEndpointType **   
The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.  
Type: String

 ** DBClusterEndpointArn **   
The Amazon Resource Name (ARN) for the endpoint.  
Type: String

 ** DBClusterEndpointIdentifier **   
The identifier associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** DBClusterEndpointResourceIdentifier **   
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.  
Type: String

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** Endpoint **   
The DNS address of the endpoint.  
Type: String

 ** EndpointType **   
The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.  
Type: String

 **ExcludedMembers.member.N**   
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.  
Type: Array of strings

 **StaticMembers.member.N**   
List of DB instance identifiers that are part of the custom endpoint group.  
Type: Array of strings

 ** Status **   
The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that can't be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database.  
Type: String

## Errors
<a name="API_CreateDBClusterEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterEndpointAlreadyExistsFault **   
The specified custom endpoint can't be created because it already exists.  
HTTP Status Code: 400

 ** DBClusterEndpointQuotaExceededFault **   
The cluster already has the maximum number of custom endpoints.  
HTTP Status Code: 403

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDBClusterEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBClusterEndpoint) 

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using `ModifyDBClusterParameterGroup`. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using `ModifyDBCluster`.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

**Important**  
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](https://console.aws.amazon.com/rds/) or the `DescribeDBClusterParameters` operation to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_CreateDBClusterParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group.  
Constraints:  
+ Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
Type: String  
Required: Yes

 ** DBParameterGroupFamily **   
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.  
 **Aurora MySQL**   
Example: `aurora-mysql5.7`, `aurora-mysql8.0`   
 **Aurora PostgreSQL**   
Example: `aurora-postgresql14`   
 **RDS for MySQL**   
Example: `mysql8.0`   
 **RDS for PostgreSQL**   
Example: `postgres13`   
To list all of the available parameter group families for a DB engine, use the following command:  
 `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`   
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:  
 `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`   
The output contains duplicates.
The following are the valid DB engine values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `mysql` 
+  `postgres` 
Type: String  
Required: Yes

 ** Description **   
The description for the DB cluster parameter group.  
Type: String  
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the DB cluster parameter group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterParameterGroup **   
Contains the details of an Amazon RDS DB cluster parameter group.  
This data type is used as a response element in the `DescribeDBClusterParameterGroups` action.  
Type: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) object

## Errors
<a name="API_CreateDBClusterParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
A DB parameter group with the same name exists.  
HTTP Status Code: 400

 ** DBParameterGroupQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB parameter groups.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBClusterParameterGroup_Examples"></a>

### Example
<a name="API_CreateDBClusterParameterGroup_Example_1"></a>

This example illustrates one usage of CreateDBClusterParameterGroup.

#### Sample Request
<a name="API_CreateDBClusterParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=CreateDBClusterParameterGroup
    &DBClusterParameterGroupName=samplegroup
    &DBParameterGroupFamily=aurora5.6
    &Description=Sample%20group
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150318/us-east-1/rds/aws4_request
    &X-Amz-Date=20150318T183624Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=86d521a3a117a033df0aa381fde0cd8a5ab5c7ab87a29aa9154438c3790ba611
```

#### Sample Response
<a name="API_CreateDBClusterParameterGroup_Example_1_Response"></a>

```
<CreateDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBClusterParameterGroupResult>
    <DBClusterParameterGroup>
      <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily>
      <Description>Sample group</Description>
      <DBClusterParameterGroupName>samplegroup</DBClusterParameterGroupName>
    </DBClusterParameterGroup>
  </CreateDBClusterParameterGroupResult>
  <ResponseMetadata>
    <RequestId>ae81a963-cd9d-11e4-8b88-8351746a4c92</RequestId>
  </ResponseMetadata>
</CreateDBClusterParameterGroupResponse>
```

## See Also
<a name="API_CreateDBClusterParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBClusterParameterGroup) 

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

Creates a snapshot of a DB cluster.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_CreateDBClusterSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing DBCluster.
Example: `my-cluster1`   
Type: String  
Required: Yes

 ** DBClusterSnapshotIdentifier **   
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster1-snapshot1`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
The tags to be assigned to the DB cluster snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterSnapshot **   
Contains the details for an Amazon RDS DB cluster snapshot  
This data type is used as a response element in the `DescribeDBClusterSnapshots` action.  
Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object

## Errors
<a name="API_CreateDBClusterSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
The user already has a DB cluster snapshot with the given identifier.  
HTTP Status Code: 400

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBClusterSnapshot_Examples"></a>

### Example
<a name="API_CreateDBClusterSnapshot_Example_1"></a>

This example illustrates one usage of CreateDBClusterSnapshot.

#### Sample Request
<a name="API_CreateDBClusterSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=CreateDBClusterSnapshot
    &DBClusterIdentifier=sample-cluster
    &DBClusterSnapshotIdentifier=sample-cluster-snapshot
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150318/us-east-1/rds/aws4_request
    &X-Amz-Date=20150318T205321Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=9573ced573a41cdec8e2ef1d9b5235a141f97ae30b4469fc9b0f16149399c4bf
```

#### Sample Response
<a name="API_CreateDBClusterSnapshot_Example_1_Response"></a>

```
<CreateDBClusterSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBClusterSnapshotResult>
    <DBClusterSnapshot>
      <Port>0</Port>
      <Engine>aurora</Engine>
      <Status>creating</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>aurora</LicenseModel>
      <DBClusterSnapshotIdentifier>sample-cluster-snapshot</DBClusterSnapshotIdentifier>
      <SnapshotCreateTime>2015-03-18T20:53:22.523Z</SnapshotCreateTime>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <VpcId>vpc-3faffe54</VpcId>
      <ClusterCreateTime>2015-03-06T22:11:13.826Z</ClusterCreateTime>
      <PercentProgress>0</PercentProgress>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>awsuser</MasterUsername>
    </DBClusterSnapshot>
  </CreateDBClusterSnapshotResult>
  <ResponseMetadata>
    <RequestId>d070d0d2-cea0-11e4-8c88-8351226c8c92</RequestId>
  </ResponseMetadata>
</CreateDBClusterSnapshotResponse>
```

## See Also
<a name="API_CreateDBClusterSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBClusterSnapshot) 

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

Creates 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, see [ Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.

For more information about creating a DB instance in an Aurora DB cluster, see [ Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_CreateDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceClass **   
The compute and memory capacity of the DB instance, for example `db.m5.large`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: Yes

 ** DBInstanceIdentifier **   
The identifier for this DB instance. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `mydbinstance`   
Type: String  
Required: Yes

 ** Engine **   
The database engine to use for this DB instance.  
Not every database engine is available in every AWS Region.  
Valid Values:  
+  `aurora-mysql` (for Aurora MySQL DB instances)
+  `aurora-postgresql` (for Aurora PostgreSQL DB instances)
+  `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
+  `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
+  `custom-oracle-se2` (for RDS Custom for Oracle DB instances)
+  `custom-oracle-se2-cdb` (for RDS Custom for Oracle DB instances)
+  `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
+  `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
+  `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)
+  `custom-sqlserver-dev` (for RDS Custom for SQL Server DB instances)
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-dev-ee` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The amount of storage in gibibytes (GiB) to allocate for the DB instance.  
This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.    
 **Amazon RDS Custom**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.  
 **RDS for Db2**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.  
 **RDS for MariaDB**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.  
 **RDS for MySQL**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.  
 **RDS for Oracle**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 10 to 3072.  
 **RDS for PostgreSQL**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.  
 **RDS for SQL Server**   
Constraints to the amount of storage for each storage type are the following:  
+ General Purpose (SSD) storage (gp2, gp3):
  + Enterprise and Standard editions: Must be an integer from 20 to 16384.
  + Web and Express editions: Must be an integer from 20 to 16384.
+ Provisioned IOPS storage (io1, io2):
  + Enterprise and Standard editions: Must be an integer from 100 to 16384.
  + Web and Express editions: Must be an integer from 100 to 16384.
+ Magnetic storage (standard):
  + Enterprise and Standard editions: Must be an integer from 20 to 1024.
  + Web and Express editions: Must be an integer from 20 to 1024.
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.  
If you create an RDS Custom DB instance, you must set `AutoMinorVersionUpgrade` to `false`.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AvailabilityZone **   
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).  
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.  
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.  
Constraints:  
+ The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment.
+ The specified Availability Zone must be in the same AWS Region as the current endpoint.
Example: `us-east-1d`   
Type: String  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to `0` disables automated backups.  
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.  
Default: `1`   
Constraints:  
+ Must be a value from 0 to 35.
+ Can't be set to 0 if the DB instance is a source to read replicas.
+ Can't be set to 0 for an RDS Custom for Oracle DB instance.
Type: Integer  
Required: No

 ** BackupTarget **   
The location for storing automated backups and manual snapshots.  
Valid Values:  
+  `local` (Dedicated Local Zone)
+  `outposts` (AWS Outposts)
+  `region` (AWS Region)
Default: `region`   
For more information, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB instance's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CharacterSetName **   
For supported engines, the character set (`CharacterSet`) to associate the DB instance with.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora - The character set is managed by the DB cluster. For more information, see `CreateDBCluster`.
+ RDS Custom - However, if you need to change the character set, you can change it on the database itself.
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.  
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.  
Type: Boolean  
Required: No

 ** CustomIamInstanceProfile **   
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.  
This setting is required for RDS Custom.  
Constraints:  
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`.
For the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** DatabaseInsightsMode **   
The mode of Database Insights to enable for the DB instance.  
Aurora DB instances inherit this value from the DB cluster, so you can't change this value.
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DBClusterIdentifier **   
The identifier of the DB cluster that this DB instance will belong to.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DBName **   
The meaning of this parameter differs according to the database engine you use.    
 **Amazon Aurora MySQL**   
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.  
Constraints:  
+ Must contain 1 to 64 alphanumeric characters.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the database engine.  
 **Amazon Aurora PostgreSQL**   
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. A database named `postgres` is always created. If this parameter is specified, an additional database with this name is created.  
Constraints:  
+ It must contain 1 to 63 alphanumeric characters.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
+ Can't be a word reserved by the database engine.  
 **Amazon RDS Custom for Oracle**   
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is `ORCL` for non-CDBs and `RDSCDB` for CDBs.  
Default: `ORCL`   
Constraints:  
+ Must contain 1 to 8 alphanumeric characters.
+ Must contain a letter.
+ Can't be a word reserved by the database engine.  
 **Amazon RDS Custom for SQL Server**   
Not applicable. Must be null.  
 **RDS for Db2**   
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. In some cases, we recommend that you don't add a database name. For more information, see [Additional considerations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations) in the *Amazon RDS User Guide*.  
Constraints:  
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.  
 **RDS for MariaDB**   
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.  
Constraints:  
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.  
 **RDS for MySQL**   
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.  
Constraints:  
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.  
 **RDS for Oracle**   
The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is `ORCL`. You can't specify the string `null`, or any other reserved word, for `DBName`.  
Default: `ORCL`   
Constraints:  
+ Can't be longer than 8 characters.  
 **RDS for PostgreSQL**   
The name of the database to create when the DB instance is created. A database named `postgres` is always created. If this parameter is specified, an additional database with this name is created.  
Constraints:  
+ Must contain 1 to 63 letters, numbers, or underscores.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.  
 **RDS for SQL Server**   
Not applicable. Must be null.
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.  
This setting doesn't apply to RDS Custom DB instances.  
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ The first character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: No

 **DBSecurityGroups.DBSecurityGroupName.N**   
A list of DB security groups to associate with this DB instance.  
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the `VpcSecurityGroupIds` setting instead.  
Type: Array of strings  
Required: No

 ** DBSubnetGroupName **   
A DB subnet group to associate with this DB instance.  
Constraints:  
+ Must match the name of an existing DB subnet group.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DBSystemId **   
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also the name of your CDB.  
Type: String  
Required: No

 ** DedicatedLogVolume **   
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see `CreateDBCluster`. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
Type: String  
Required: No

 ** DomainAuthSecretArn **   
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.  
Example: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`   
Type: String  
Required: No

 **DomainDnsIps.member.N**   
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.  
Constraints:  
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: `123.124.125.126,234.235.236.237`   
Type: Array of strings  
Required: No

 ** DomainFqdn **   
The fully qualified domain name (FQDN) of an Active Directory domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `mymanagedADtest.mymanagedAD.mydomain`   
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
Type: String  
Required: No

 ** DomainOu **   
The Active Directory organizational unit for your DB instance to join.  
Constraints:  
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.
Example: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`   
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of log types to enable for exporting to CloudWatch Logs. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
+ RDS Custom
The following values are valid for each DB engine:  
+ RDS for Db2 - `diag.log | notify.log | iam-db-auth-error` 
+ RDS for MariaDB - `audit | error | general | slowquery | iam-db-auth-error` 
+ RDS for Microsoft SQL Server - `agent | error` 
+ RDS for MySQL - `audit | error | general | slowquery | iam-db-auth-error` 
+ RDS for Oracle - `alert | audit | listener | trace | oemagent` 
+ RDS for PostgreSQL - `postgresql | upgrade | iam-db-auth-error` 
Type: Array of strings  
Required: No

 ** EnableCustomerOwnedIp **   
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.  
A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.  
For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*.  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (Mapping AWS IAM accounts to database accounts is managed by the DB cluster.)
+ RDS Custom
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB instance.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.  
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to use.  
This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.  
For a list of valid engine versions, use the `DescribeDBEngineVersions` operation.  
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.    
 **Amazon RDS Custom for Oracle**   
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.*customized\$1string*. A valid CEV name is `19.my_cev1`. For more information, see [ Creating an RDS Custom for Oracle DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) in the *Amazon RDS User Guide*.  
 **Amazon RDS Custom for SQL Server**   
See [RDS Custom for SQL Server general requirements](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html) in the *Amazon RDS User Guide*.  
 **RDS for Db2**   
For information, see [Db2 on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.  
 **RDS for MariaDB**   
For information, see [MariaDB on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.  
 **RDS for Microsoft SQL Server**   
For information, see [Microsoft SQL Server versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide*.  
 **RDS for MySQL**   
For information, see [MySQL on Amazon RDS versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.  
 **RDS for Oracle**   
For information, see [Oracle Database Engine release notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide*.  
 **RDS for PostgreSQL**   
For information, see [Amazon RDS for PostgreSQL versions and extensions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see [Amazon RDS DB instance storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.  
Constraints:  
+ For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
+ For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
This setting doesn't apply to Amazon Aurora DB instances. The AWS KMS key identifier is managed by the DB cluster. For more information, see `CreateDBCluster`.  
If `StorageEncrypted` is enabled, and you do not specify a value for the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling `StorageEncrypted`, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.  
Type: String  
Required: No

 ** LicenseModel **   
The license model information for this DB instance.  
License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an AWS License Manager self-managed license. The Db2 license through AWS Marketplace model requires an AWS Marketplace subscription. For more information, see [Amazon RDS for Db2 licensing options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide*.  
The default for RDS for Db2 is `bring-your-own-license`.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Valid Values:  
+ RDS for Db2 - `bring-your-own-license | marketplace-license` 
+ RDS for MariaDB - `general-public-license` 
+ RDS for Microsoft SQL Server - `license-included` 
+ RDS for MySQL - `general-public-license` 
+ RDS for Oracle - `bring-your-own-license | license-included` 
+ RDS for PostgreSQL - `postgresql-license` 
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUserAuthenticationType **   
Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.  
You can specify one of the following values:  
+  `password` - Use standard database authentication with a password.
+  `iam-db-auth` - Use IAM database authentication for the master user.
This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.  
Type: String  
Valid Values: `password | iam-db-auth`   
Required: No

 ** MasterUsername **   
The name for the master user.  
This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.  
This setting is required for RDS DB instances.  
Constraints:  
+ Must be 1 to 16 letters, numbers, or underscores.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
Type: String  
Required: No

 ** MasterUserPassword **   
The password for the master user.  
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.  
Constraints:  
+ Can't be specified if `ManageMasterUserPassword` is turned on.
+ Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:  
+ RDS for Db2 - Must contain from 8 to 255 characters.
+ RDS for MariaDB - Must contain from 8 to 41 characters.
+ RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
+ RDS for MySQL - Must contain from 8 to 41 characters.
+ RDS for Oracle - Must contain from 8 to 30 characters.
+ RDS for PostgreSQL - Must contain from 8 to 128 characters.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** MaxAllocatedStorage **   
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.  
For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (Storage is managed by the DB cluster.)
+ RDS Custom
Type: Integer  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than `0`.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.  
If `MonitoringInterval` is set to a value other than `0`, then you must supply a `MonitoringRoleArn` value.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** MultiAZ **   
Specifies whether the DB instance is a Multi-AZ deployment. You can't set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.  
This setting doesn't apply to Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster.  
Type: Boolean  
Required: No

 ** MultiTenant **   
Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.  
Note the following restrictions:   
+ The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn't support it, the request fails.
+ If you specify the multi-tenant configuration when you create your DB instance, you can't later modify this DB instance to use the single-tenant configuration.
Type: Boolean  
Required: No

 ** NcharCharacterSetName **   
The name of the NCHAR character set for the Oracle DB instance.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Valid Values: `IPV4 | DUAL`   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to associate the DB instance with.  
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS returns an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the database accepts connections.  
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.  
Valid Values: `1150-65535`   
Default:  
+ RDS for Db2 - `50000` 
+ RDS for MariaDB - `3306` 
+ RDS for Microsoft SQL Server - `1433` 
+ RDS for MySQL - `3306` 
+ RDS for Oracle - `1521` 
+ RDS for PostgreSQL - `5432` 
Constraints:  
+ For RDS for Microsoft SQL Server, the value can't be `1234`, `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information, see [Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The time range each week during which system maintenance can occur. For more information, see [Amazon RDS Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) in the *Amazon RDS User Guide.*   
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.  
Constraints:  
+ Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
+ The day values must be `mon | tue | wed | thu | fri | sat | sun`. 
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred backup window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PromotionTier **   
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [ Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Default: `1`   
Valid Values: `0 - 15`   
Type: Integer  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is controlled by its security group settings.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
The default behavior when `PubliclyAccessible` is not specified depends on whether a `DBSubnetGroup` is specified.  
If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to `false` for Aurora instances and `true` for non-Aurora instances.  
If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to `false` unless the value of `DBSubnetGroup` is `default`, in which case `PubliclyAccessible` defaults to `true`.  
If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup` is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.  
Type: Boolean  
Required: No

 ** StorageEncrypted **   
Specifes whether the DB instance is encrypted. By default, it isn't encrypted.  
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.  
This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.  
Type: Boolean  
Required: No

 ** StorageThroughput **   
The storage throughput value, in mebibyte per second (MiBps), for the DB instance.  
This setting applies only to the `gp3` storage type.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Type: Integer  
Required: No

 ** StorageType **   
The storage type to associate with the DB instance.  
If you specify `io1`, `io2`, or `gp3`, you must also include a value for the `Iops` parameter.  
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
Default: `io1`, if the `Iops` parameter is specified. Otherwise, `gp3`.  
Type: String  
Required: No

 **Tags.Tag.N**   
Tags to assign to the DB instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** TdeCredentialArn **   
The ARN from the key store with which to associate the instance for TDE encryption.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Type: String  
Required: No

 ** TdeCredentialPassword **   
The password for the given ARN from the key store in order to access the device.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** Timezone **   
The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).  
Type: String  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of Amazon EC2 VPC security groups to associate with this DB instance.  
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.  
Default: The default EC2 VPC security group for the DB subnet group's VPC.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_CreateDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_CreateDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** BackupPolicyNotFoundFault **   
 *This error has been deprecated.*   
  
HTTP Status Code: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBInstance_Examples"></a>

### Example
<a name="API_CreateDBInstance_Example_1"></a>

This example illustrates one usage of CreateDBInstance.

#### Sample Request
<a name="API_CreateDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBInstance
   &AllocatedStorage=15
   &DBInstanceClass=db.m5.large
   &DBInstanceIdentifier=myawsuser-dbi01
   &Engine=MySQL
   &MasterUserPassword=<password>
   &MasterUsername=myawsuser
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140424/us-east-1/rds/aws4_request
   &X-Amz-Date=20140424T194844Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=bee4aabc750bf7dad0cd9e22b952bd6089d91e2a16592c2293e532eeaab8bc77
```

#### Sample Response
<a name="API_CreateDBInstance_Example_1_Response"></a>

```
<CreateDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBInstanceResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DBInstanceStatus>creating</DBInstanceStatus>
      <MultiAZ>false</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>myawsuser-dbi01</DBInstanceIdentifier>
      
      <PreferredBackupWindow>03:50-04:20</PreferredBackupWindow>
      <PreferredMaintenanceWindow>wed:06:38-wed:07:08</PreferredMaintenanceWindow>
      <ReadReplicaDBInstanceIdentifiers/>
      <Engine>mysql</Engine>
      <PendingModifiedValues>
        <MasterUserPassword>****</MasterUserPassword>
      </PendingModifiedValues>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <PubliclyAccessible>true</PubliclyAccessible>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <AllocatedStorage>15</AllocatedStorage>
      <DBInstanceClass>db.m5.large</DBInstanceClass>
      <MasterUsername>myawsuser</MasterUsername>
    </DBInstance>
  </CreateDBInstanceResult>
  <ResponseMetadata>
    <RequestId>523e3218-afc7-11c3-90f5-f90431260ab4</RequestId>
  </ResponseMetadata>
</CreateDBInstanceResponse>
```

## See Also
<a name="API_CreateDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBInstance) 

# CreateDBInstanceReadReplica
<a name="API_CreateDBInstanceReadReplica"></a>

Creates 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 PostgreSQL. For more information, see [Working with read replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) and [Migrating from a Multi-AZ DB cluster to a DB instance using a read replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica) in the *Amazon RDS User Guide*.

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the `CreateDBInstance` operation.

RDS creates read replicas with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

**Important**  
Your source DB instance or cluster must have backup retention enabled.

## Request Parameters
<a name="API_CreateDBInstanceReadReplica_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in `CreateDBInstance`.  
This setting isn't valid for RDS for SQL Server.  
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.  
This setting doesn't apply to RDS Custom DB instances.  
Default: Inherits the value from the source DB instance.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AvailabilityZone **   
The Availability Zone (AZ) where the read replica will be created.  
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.  
Example: `us-east-1d`   
Type: String  
Required: No

 ** BackupTarget **   
The location where RDS stores automated backups and manual snapshots.  
Valid Values:  
+  `local` for Dedicated Local Zones
+  `region` for AWS Region 
Type: String  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the read replica's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied.  
Type: Boolean  
Required: No

 ** CustomIamInstanceProfile **   
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:  
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`.
For the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.  
This setting is required for RDS Custom DB instances.  
Type: String  
Required: No

 ** DatabaseInsightsMode **   
The mode of Database Insights to enable for the read replica.  
This setting isn't supported.
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DBInstanceClass **   
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.  
Default: Inherits the value from the source DB instance.  
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to associate with this read replica DB instance.  
For the Db2 DB engine, if your source DB instance uses the bring your own license (BYOL) model, then a custom parameter group must be associated with the replica. For a same AWS Region replica, if you don't specify a custom parameter group, Amazon RDS associates the custom parameter group associated with the source DB instance. For a cross-Region replica, you must specify a custom parameter group. This custom parameter group must include your IBM Site ID and IBM Customer ID. For more information, see [IBM IDs for bring your own license (BYOL) for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info).   
For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a value for `DBParameterGroupName`, then Amazon RDS uses the `DBParameterGroup` of the source DB instance for a same Region read replica, or the default `DBParameterGroup` for the specified DB engine for a cross-Region read replica.  
For Multi-AZ DB cluster same Region read replica instances, if you don't specify a value for `DBParameterGroupName`, then Amazon RDS uses the default `DBParameterGroup`.  
Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.  
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: No

 ** DBSubnetGroupName **   
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.  
Constraints:  
+ If supplied, must match the name of an existing DB subnet group.
+ The specified DB subnet group must be in the same AWS Region in which the operation is running.
+ All read replicas in one AWS Region that are created from the same source DB instance must either:
  + Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
  + Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DedicatedLogVolume **   
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainAuthSecretArn **   
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.  
Example: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`   
Type: String  
Required: No

 **DomainDnsIps.member.N**   
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.  
Constraints:  
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: `123.124.125.126,234.235.236.237`   
Type: Array of strings  
Required: No

 ** DomainFqdn **   
The fully qualified domain name (FQDN) of an Active Directory domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `mymanagedADtest.mymanagedAD.mydomain`   
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainOu **   
The Active Directory organizational unit for your DB instance to join.  
Constraints:  
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.
Example: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`   
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs ](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Array of strings  
Required: No

 ** EnableCustomerOwnedIp **   
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.  
A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.  
For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*.  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to enable Performance Insights for the read replica.  
For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.  
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted read replica.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you create an encrypted read replica in the same AWS Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same AWS Region is always encrypted with the same KMS key as the source DB instance or cluster.  
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key identifier for the destination AWS Region. KMS keys are specific to the AWS Region that they are created in, and you can't use KMS keys from one AWS Region in another AWS Region.  
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.  
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.  
Type: String  
Required: No

 ** MaxAllocatedStorage **   
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.  
For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.  
Type: Integer  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify `0`. The default is `0`.  
If `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than `0`.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values: `0, 1, 5, 10, 15, 30, 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, go to [To create an IAM role for Amazon RDS Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) in the *Amazon RDS User Guide*.  
If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** MultiAZ **   
Specifies whether the read replica is in a Multi-AZ deployment.  
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for read replica. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.  
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS returns an error.  
Type: Integer  
Required: No

 ** Port **   
The port number that the DB instance uses for connections.  
Valid Values: `1150-65535`   
Default: Inherits the value from the source DB instance.  
Type: Integer  
Required: No

 ** PreSignedUrl **   
When you are creating a read replica from one AWS GovCloud (US) Region to another or from one China AWS Region to another, the URL that contains a Signature Version 4 signed request for the `CreateDBInstanceReadReplica` API operation in the source AWS Region that contains the source DB instance.  
This setting applies only to AWS GovCloud (US) Regions and China AWS Regions. It's ignored in other AWS Regions.  
This setting applies only when replicating from a source DB *instance*. Source DB clusters aren't supported in AWS GovCloud (US) Regions and China AWS Regions.  
You must specify this parameter when you create an encrypted read replica from another AWS Region by using the Amazon RDS API. Don't specify `PreSignedUrl` when you are creating an encrypted read replica in the same AWS Region.  
The presigned URL must be a valid request for the `CreateDBInstanceReadReplica` API operation that can run in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:  
+  `DestinationRegion` - The AWS Region that the encrypted read replica is created in. This AWS Region is the same one where the `CreateDBInstanceReadReplica` operation is called that contains this presigned URL.

  For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the `CreateDBInstanceReadReplica` operation in the us-east-1 AWS Region and provide a presigned URL that contains a call to the `CreateDBInstanceReadReplica` operation in the us-west-2 AWS Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 AWS Region.
+  `KmsKeyId` - The AWS KMS key identifier for the key to use to encrypt the read replica in the destination AWS Region. This is the same identifier for both the `CreateDBInstanceReadReplica` operation that is called in the destination AWS Region, and the operation contained in the presigned URL.
+  `SourceDBInstanceIdentifier` - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 AWS Region, then your `SourceDBInstanceIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).  
If you are using an AWS SDK tool or the AWS CLI, you can specify `SourceRegion` (or `--source-region` for the AWS CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source AWS Region.
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBInstance](API_CreateDBInstance.md).  
Type: Boolean  
Required: No

 ** ReplicaMode **   
The open mode of the replica database.  
This parameter is only supported for Db2 DB instances and Oracle DB instances.    
 **Db2**   
Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload.  
You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see [Working with replicas for Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html) in the *Amazon RDS User Guide*.  
To create standby DB replicas for RDS for Db2, set this parameter to `mounted`.  
 **Oracle**   
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.  
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see [Working with read replicas for Amazon RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.  
For RDS Custom, you must specify this parameter and set it to `mounted`. The value won't be set by default. After replica creation, you can manage the open mode manually.
Type: String  
Valid Values: `open-read-only | mounted`   
Required: No

 ** SourceDBClusterIdentifier **   
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.  
Constraints:  
+ Must be the identifier of an existing Multi-AZ DB cluster.
+ Can't be specified if the `SourceDBInstanceIdentifier` parameter is also specified.
+ The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.
Type: String  
Required: No

 ** SourceDBInstanceIdentifier **   
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, except for the following engines:  
+ Db2 - Can have up to three replicas.
+ Oracle - Can have up to five read replicas.
+ SQL Server - Can have up to five read replicas.
Constraints:  
+ Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
+ Can't be specified if the `SourceDBClusterIdentifier` parameter is also specified.
+ For the limitations of Oracle read replicas, see [Version and licensing considerations for RDS for Oracle replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses) in the *Amazon RDS User Guide*.
+ For the limitations of SQL Server read replicas, see [Read replica limitations with SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations) in the *Amazon RDS User Guide*.
+ The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ If the source DB instance is in the same AWS Region as the read replica, specify a valid DB instance identifier.
+ If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. For more information, see [Constructing an ARN for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the *Amazon RDS User Guide*. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
Type: String  
Required: No

 ** StorageThroughput **   
Specifies the storage throughput value for the read replica.  
This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.  
Type: Integer  
Required: No

 ** StorageType **   
The storage type to associate with the read replica.  
If you specify `io1`, `io2`, or `gp3`, you must also include a value for the `Iops` parameter.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
Default: `io1` if the `Iops` parameter is specified. Otherwise, `gp3`.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** UpgradeStorageConfig **   
Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.  
Type: Boolean  
Required: No

 ** UseDefaultProcessorFeatures **   
Specifies whether the DB instance class of the DB instance uses its default processor features.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of Amazon EC2 VPC security groups to associate with the read replica.  
This setting doesn't apply to RDS Custom DB instances.  
Default: The default EC2 VPC security group for the DB subnet group's VPC.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_CreateDBInstanceReadReplica_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_CreateDBInstanceReadReplica_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotAllowedFault **   
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupFault **   
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBInstanceReadReplica_Examples"></a>

### Example
<a name="API_CreateDBInstanceReadReplica_Example_1"></a>

This example illustrates one usage of CreateDBInstanceReadReplica.

#### Sample Request
<a name="API_CreateDBInstanceReadReplica_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBInstanceReadReplica
   &DBInstanceIdentifier=mysqldb-rr
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceDBInstanceIdentifier=mysqldb
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T170525Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=a5bc7bb9648272e9967c76fc582b308d3ee37d6c4f7a4eb62c2d885ec595c373
```

#### Sample Response
<a name="API_CreateDBInstanceReadReplica_Example_1_Response"></a>

```
<CreateDBInstanceReadReplicaResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBInstanceReadReplicaResult>
    <DBInstance>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <MultiAZ>false</MultiAZ>
      <DBInstanceStatus>creating</DBInstanceStatus>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mysqldb-rr</DBInstanceIdentifier>
      <PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <ReadReplicaDBInstanceIdentifiers/>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <ReadReplicaSourceDBInstanceIdentifier>mysqldb</ReadReplicaSourceDBInstanceIdentifier>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>pending-apply</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>mysqldb</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
    </DBInstance>
  </CreateDBInstanceReadReplicaResult>
  <ResponseMetadata>
    <RequestId>ba8dedf0-bb9a-11d3-855b-576787000e19</RequestId>
  </ResponseMetadata>
</CreateDBInstanceReadReplicaResponse>
```

## See Also
<a name="API_CreateDBInstanceReadReplica_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBInstanceReadReplica) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBInstanceReadReplica) 

# CreateDBParameterGroup
<a name="API_CreateDBParameterGroup"></a>

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using `ModifyDBParameterGroup`. Once you've created a DB parameter group, you need to associate it with your DB instance using `ModifyDBInstance`. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn't apply to RDS Custom.

## Request Parameters
<a name="API_CreateDBParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupFamily **   
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.  
To list all of the available parameter group families for a DB engine, use the following command:  
 `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`   
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:  
 `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`   
The output contains duplicates.
The following are the valid DB engine values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `db2-ae` 
+  `db2-se` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: Yes

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Type: String  
Required: Yes

 ** Description **   
The description for the DB parameter group.  
Type: String  
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the DB parameter group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBParameterGroup **   
Contains the details of an Amazon RDS DB parameter group.  
This data type is used as a response element in the `DescribeDBParameterGroups` action.  
Type: [DBParameterGroup](API_DBParameterGroup.md) object

## Errors
<a name="API_CreateDBParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
A DB parameter group with the same name exists.  
HTTP Status Code: 400

 ** DBParameterGroupQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB parameter groups.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBParameterGroup_Examples"></a>

### Example
<a name="API_CreateDBParameterGroup_Example_1"></a>

This example illustrates one usage of CreateDBParameterGroup.

#### Sample Request
<a name="API_CreateDBParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBParameterGroup
   &DBParameterGroupFamily=MySQL5.1
   &DBParameterGroupName=mydbparamgroup3
   &Description=My%20new%20DB%20Parameter%20Group
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T201938Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e9e5e723f627e872e8bccdc6ccc60bdffcf4a32ae6758ef0a3717ffae49097ae
```

#### Sample Response
<a name="API_CreateDBParameterGroup_Example_1_Response"></a>

```
<CreateDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBParameterGroupResult>
    <DBParameterGroup>
      <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
      <Description>My new DB Parameter Group</Description>
      <DBParameterGroupName>mydbparamgroup3</DBParameterGroupName>
    </DBParameterGroup>
  </CreateDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>7805c127-af22-11c3-96ac-6999cc5f7e72</RequestId>
  </ResponseMetadata>
</CreateDBParameterGroupResponse>
```

## See Also
<a name="API_CreateDBParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBParameterGroup) 

# CreateDBProxy
<a name="API_CreateDBProxy"></a>

Creates a new DB proxy.

## Request Parameters
<a name="API_CreateDBProxy_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** EngineFamily **   
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify `SQLSERVER`.  
Type: String  
Valid Values: `MYSQL | POSTGRESQL | SQLSERVER`   
Required: Yes

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 **VpcSubnetIds.member.N**   
One or more VPC subnet IDs to associate with the new proxy.  
Type: Array of strings  
Required: Yes

 **Auth.member.N**   
The authorization mechanism that the proxy uses.  
Type: Array of [UserAuthConfig](API_UserAuthConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** DebugLogging **   
Specifies whether the proxy logs detailed connection and query information. When you enable `DebugLogging`, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.  
Type: Boolean  
Required: No

 ** DefaultAuthScheme **   
The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are `NONE` and `IAM_AUTH`. When set to `IAM_AUTH`, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify `DefaultAuthScheme` or specify this parameter as `NONE`, you must specify the `Auth` option.  
Type: String  
Valid Values: `IAM_AUTH | NONE`   
Required: No

 ** EndpointNetworkType **   
The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.  
Valid values:  
+  `IPV4` - The proxy endpoint supports IPv4 only.
+  `IPV6` - The proxy endpoint supports IPv6 only.
+  `DUAL` - The proxy endpoint supports both IPv4 and IPv6.
Default: `IPV4`   
Constraints:  
+ If you specify `IPV6` or `DUAL`, the VPC and all subnets must have an IPv6 CIDR block.
+ If you specify `IPV6` or `DUAL`, the VPC tenancy cannot be `dedicated`.
Type: String  
Valid Values: `IPV4 | IPV6 | DUAL`   
Required: No

 ** IdleClientTimeout **   
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.  
Type: Integer  
Required: No

 ** RequireTLS **   
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.  
Type: Boolean  
Required: No

 **Tags.Tag.N**   
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TargetConnectionNetworkType **   
The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.  
Valid values:  
+  `IPV4` - The proxy connects to the database using IPv4 only.
+  `IPV6` - The proxy connects to the database using IPv6 only.
Default: `IPV4`   
Constraints:  
+ If you specify `IPV6`, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.
+ All targets registered with the proxy must be compatible with the specified network type.
Type: String  
Valid Values: `IPV4 | IPV6`   
Required: No

 **VpcSecurityGroupIds.member.N**   
One or more VPC security group IDs to associate with the new proxy.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_CreateDBProxy_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxy **   
The `DBProxy` structure corresponding to the new proxy.  
Type: [DBProxy](API_DBProxy.md) object

## Errors
<a name="API_CreateDBProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyAlreadyExistsFault **   
The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** DBProxyQuotaExceededFault **   
Your AWS account already has the maximum number of proxies in the specified AWS Region.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDBProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBProxy) 

# CreateDBProxyEndpoint
<a name="API_CreateDBProxyEndpoint"></a>

Creates 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.

## Request Parameters
<a name="API_CreateDBProxyEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyEndpointName **   
The name of the DB proxy endpoint to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** DBProxyName **   
The name of the DB proxy associated with the DB proxy endpoint that you create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **VpcSubnetIds.member.N**   
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.  
Type: Array of strings  
Required: Yes

 ** EndpointNetworkType **   
The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.  
Valid values:  
+  `IPV4` - The proxy endpoint supports IPv4 only.
+  `IPV6` - The proxy endpoint supports IPv6 only.
+  `DUAL` - The proxy endpoint supports both IPv4 and IPv6.
Default: `IPV4`   
Constraints:  
+ If you specify `IPV6` or `DUAL`, the VPC and all subnets must have an IPv6 CIDR block.
+ If you specify `IPV6` or `DUAL`, the VPC tenancy cannot be `dedicated`.
Type: String  
Valid Values: `IPV4 | IPV6 | DUAL`   
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TargetRole **   
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is `READ_WRITE`. The only role that proxies for RDS for Microsoft SQL Server support is `READ_WRITE`.  
Type: String  
Valid Values: `READ_WRITE | READ_ONLY`   
Required: No

 **VpcSecurityGroupIds.member.N**   
The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_CreateDBProxyEndpoint_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxyEndpoint **   
The `DBProxyEndpoint` object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.  
Type: [DBProxyEndpoint](API_DBProxyEndpoint.md) object

## Errors
<a name="API_CreateDBProxyEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyEndpointAlreadyExistsFault **   
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** DBProxyEndpointQuotaExceededFault **   
The DB proxy already has the maximum number of endpoints.  
HTTP Status Code: 400

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDBProxyEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBProxyEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBProxyEndpoint) 

# CreateDBSecurityGroup
<a name="API_CreateDBSecurityGroup"></a>

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

**Note**  
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-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_CreateDBSecurityGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSecurityGroupDescription **   
The description for the DB security group.  
Type: String  
Required: Yes

 ** DBSecurityGroupName **   
The name for the DB security group. This value is stored as a lowercase string.  
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
+ Must not be "Default"
Example: `mysecuritygroup`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the DB security group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBSecurityGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBSecurityGroup **   
Contains the details for an Amazon RDS DB security group.  
This data type is used as a response element in the `DescribeDBSecurityGroups` action.  
Type: [DBSecurityGroup](API_DBSecurityGroup.md) object

## Errors
<a name="API_CreateDBSecurityGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSecurityGroupAlreadyExists **   
A DB security group with the name specified in `DBSecurityGroupName` already exists.  
HTTP Status Code: 400

 ** DBSecurityGroupNotSupported **   
A DB security group isn't allowed for this action.  
HTTP Status Code: 400

 ** QuotaExceeded.DBSecurityGroup **   
The request would result in the user exceeding the allowed number of DB security groups.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBSecurityGroup_Examples"></a>

### Example
<a name="API_CreateDBSecurityGroup_Example_1"></a>

This example illustrates one usage of CreateDBSecurityGroup.

#### Sample Request
<a name="API_CreateDBSecurityGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBSecurityGroup
   &DBSecurityGroupDescription=My%20new%20DB%20Security%20Group
   &DBSecurityGroupName=mydbsecuritygroup00
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140424/us-east-1/rds/aws4_request
   &X-Amz-Date=20140424T190716Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=c2f180a3f0f5d73b47f9c229937a78f3569bf14392db8093d9b2e6785609ab45
```

#### Sample Response
<a name="API_CreateDBSecurityGroup_Example_1_Response"></a>

```
<CreateDBSecurityGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBSecurityGroupResult>
    <DBSecurityGroup>
      <EC2SecurityGroups/>
      <DBSecurityGroupDescription>My new DB Security Group</DBSecurityGroupDescription>
      <IPRanges/>
      <OwnerId>803#########</OwnerId>
      <DBSecurityGroupName>mydbsecuritygroup00</DBSecurityGroupName>
    </DBSecurityGroup>
  </CreateDBSecurityGroupResult>
  <ResponseMetadata>
    <RequestId>e68ef6fa-afc1-11c3-845a-476777009d19</RequestId>
  </ResponseMetadata>
</CreateDBSecurityGroupResponse>
```

## See Also
<a name="API_CreateDBSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBSecurityGroup) 

# CreateDBShardGroup
<a name="API_CreateDBShardGroup"></a>

Creates 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

## Request Parameters
<a name="API_CreateDBShardGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the primary DB cluster for the DB shard group.  
Type: String  
Required: Yes

 ** DBShardGroupIdentifier **   
The name of the DB shard group.  
Type: String  
Required: Yes

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double  
Required: Yes

 ** ComputeRedundancy **   
Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.
+ 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
Type: Integer  
Required: No

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB shard group is publicly accessible.  
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.  
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.  
Default: The default behavior varies depending on whether `DBSubnetGroupName` is specified.  
If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
+ If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
Type: Boolean  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBShardGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ComputeRedundancy **   
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
+ 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
Type: Integer

 ** DBClusterIdentifier **   
The name of the primary DB cluster for the DB shard group.  
Type: String

 ** DBShardGroupArn **   
The Amazon Resource Name (ARN) for the DB shard group.  
Type: String

 ** DBShardGroupIdentifier **   
The name of the DB shard group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** DBShardGroupResourceId **   
The AWS Region-unique, immutable identifier for the DB shard group.  
Type: String

 ** Endpoint **   
The connection endpoint for the DB shard group.  
Type: String

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** PubliclyAccessible **   
Indicates whether the DB shard group is publicly accessible.  
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.  
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBShardGroup](#API_CreateDBShardGroup).  
This setting is only for Aurora Limitless Database.  
Type: Boolean

 ** Status **   
The status of the DB shard group.  
Type: String

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_CreateDBShardGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBShardGroupAlreadyExists **   
The specified DB shard group name must be unique in your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** MaxDBShardGroupLimitReached **   
The maximum number of DB shard groups for your AWS account in the specified AWS Region has been reached.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** UnsupportedDBEngineVersion **   
The specified DB engine version isn't supported for Aurora Limitless Database.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDBShardGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBShardGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBShardGroup) 

# CreateDBSnapshot
<a name="API_CreateDBSnapshot"></a>

Creates a snapshot of a DB instance. The source DB instance must be in the `available` or `storage-optimization` state.

## Request Parameters
<a name="API_CreateDBSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The identifier of the DB instance that you want to create the snapshot of.  
Constraints:  
+ Must match the identifier of an existing DBInstance.
Type: String  
Required: Yes

 ** DBSnapshotIdentifier **   
The identifier for the DB snapshot.  
Constraints:  
+ Can't be null, empty, or blank
+ Must contain from 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-snapshot-id`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshot **   
Contains the details of an Amazon RDS DB snapshot.  
This data type is used as a response element in the `DescribeDBSnapshots` action.  
Type: [DBSnapshot](API_DBSnapshot.md) object

## Errors
<a name="API_CreateDBSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` is already used by an existing snapshot.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBSnapshot_Examples"></a>

### Example
<a name="API_CreateDBSnapshot_Example_1"></a>

This example illustrates one usage of CreateDBSnapshot.

#### Sample Request
<a name="API_CreateDBSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBSnapshot
   &DBInstanceIdentifier=mysqldb-02
   &DBSnapshotIdentifier=mySQLdb-snap-1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T161105Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e9649af6edcfbab4016f04d72e1b7fc16d8734c37477afcf25b3def625484ed2
```

#### Sample Response
<a name="API_CreateDBSnapshot_Example_1_Response"></a>

```
<CreateDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>creating</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <DBInstanceIdentifier>mysqldb-02</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysqldb-snap-1</DBSnapshotIdentifier>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2014-04-21T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>0</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </CreateDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>bd80a25a-af09-11c3-ed11-23c32f9aa7d3</RequestId>
  </ResponseMetadata>
</CreateDBSnapshotResponse>
```

## See Also
<a name="API_CreateDBSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBSnapshot) 

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

## Request Parameters
<a name="API_CreateDBSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSubnetGroupDescription **   
The description for the DB subnet group.  
Type: String  
Required: Yes

 ** DBSubnetGroupName **   
The name for the DB subnet group. This value is stored as a lowercase string.  
Constraints:  
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
+ Must not be default.
+ First character must be a letter.
Example: `mydbsubnetgroup`   
Type: String  
Required: Yes

 **SubnetIds.SubnetIdentifier.N**   
The EC2 Subnet IDs for the DB subnet group.  
Type: Array of strings  
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the DB subnet group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBSubnetGroup **   
Contains the details of an Amazon RDS DB subnet group.  
This data type is used as a response element in the `DescribeDBSubnetGroups` action.  
Type: [DBSubnetGroup](API_DBSubnetGroup.md) object

## Errors
<a name="API_CreateDBSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName` is already used by an existing DB subnet group.  
HTTP Status Code: 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB subnet groups.  
HTTP Status Code: 400

 ** DBSubnetQuotaExceededFault **   
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDBSubnetGroup_Examples"></a>

### Example
<a name="API_CreateDBSubnetGroup_Example_1"></a>

This example illustrates one usage of CreateDBSubnetGroup.

#### Sample Request
<a name="API_CreateDBSubnetGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBSubnetGroup
   &DBSubnetGroupDescription=My%20new%20DB%20Subnet%20Group
   &DBSubnetGroupName=myawsuser-dbsubnetgroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SubnetIds.member.1=subnet-e4d398a1
   &SubnetIds.member.2=subnet-c2bdb6ba
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T173028Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=f434cd02a766ea034637debf67996a743ca3e098efc9a5881c61e0c6859259d3
```

#### Sample Response
<a name="API_CreateDBSubnetGroup_Example_1_Response"></a>

```
<CreateDBSubnetGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBSubnetGroupResult>
    <DBSubnetGroup>
      <VpcId>vpc-33dc97ea</VpcId>
      <SubnetGroupStatus>Complete</SubnetGroupStatus>
      <DBSubnetGroupDescription>My new DB subnet group</DBSubnetGroupDescription>
      <DBSubnetGroupName>myawsuser-dbsubnetgroup</DBSubnetGroupName>
      <Subnets>
        <Subnet>
          <SubnetStatus>Active</SubnetStatus>
          <SubnetIdentifier>subnet-e4d398a1</SubnetIdentifier>
          <SubnetAvailabilityZone>
            <Name>us-east-1b</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
          </SubnetAvailabilityZone>
        </Subnet>
        <Subnet>
          <SubnetStatus>Active</SubnetStatus>
          <SubnetIdentifier>subnet-c2bdb6ba</SubnetIdentifier>
          <SubnetAvailabilityZone>
            <Name>us-east-1c</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
          </SubnetAvailabilityZone>
        </Subnet>
      </Subnets>
    </DBSubnetGroup>
  </CreateDBSubnetGroupResult>
  <ResponseMetadata>
    <RequestId>3a401b3f-bb9e-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</CreateDBSubnetGroupResponse>
```

## See Also
<a name="API_CreateDBSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateDBSubnetGroup) 

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Creates 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 console.

You can specify the type of source (`SourceType`) that you want to be notified of and provide a list of RDS sources (`SourceIds`) that triggers the events. You can also provide a list of event categories (`EventCategories`) for events that 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 `SourceIds` = `myDBInstance1`, you are notified of all the `db-instance` events for the specified source. If you specify a `SourceType` but do not specify `SourceIds`, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the `SourceIds`, you are notified of events generated from all RDS sources belonging to your customer account.

For more information about subscribing to an event for RDS DB engines, see [ Subscribing to Amazon RDS event notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Subscribing.html) in the *Amazon RDS User Guide*.

For more information about subscribing to an event for Aurora DB engines, see [ Subscribing to Amazon RDS event notification](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Subscribing.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_CreateEventSubscription_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SnsTopicArn **   
The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.  
RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.
Type: String  
Required: Yes

 ** SubscriptionName **   
The name of the subscription.  
Constraints: The name must be less than 255 characters.  
Type: String  
Required: Yes

 ** Enabled **   
Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.  
Type: Boolean  
Required: No

 **EventCategories.EventCategory.N**   
A list of event categories for a particular source type (`SourceType`) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the `DescribeEventCategories` operation.  
Type: Array of strings  
Required: No

 **SourceIds.SourceId.N**   
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.  
Constraints:  
+ If `SourceIds` are supplied, `SourceType` must also be provided.
+ If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied.
+ If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied.
+ If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied.
+ If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied.
+ If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied.
+ If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied.
+ If the source type is an RDS Proxy, a `DBProxyName` value must be supplied.
Type: Array of strings  
Required: No

 ** SourceType **   
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`. If this value isn't specified, all events are returned.  
Valid Values:` db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment `   
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateEventSubscription_ResponseElements"></a>

The following element is returned by the service.

 ** EventSubscription **   
Contains the results of a successful invocation of the `DescribeEventSubscriptions` action.  
Type: [EventSubscription](API_EventSubscription.md) object

## Errors
<a name="API_CreateEventSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
You have reached the maximum number of event subscriptions.  
HTTP Status Code: 400

 ** SNSInvalidTopic **   
SNS has responded that there is a problem with the SNS topic specified.  
HTTP Status Code: 400

 ** SNSNoAuthorization **   
You do not have permission to publish to the SNS topic ARN.  
HTTP Status Code: 400

 ** SNSTopicArnNotFound **   
The SNS topic ARN does not exist.  
HTTP Status Code: 404

 ** SourceNotFound **   
The requested source could not be found.  
HTTP Status Code: 404

 ** SubscriptionAlreadyExist **   
The supplied subscription name already exists.  
HTTP Status Code: 400

 ** SubscriptionCategoryNotFound **   
The supplied category does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_CreateEventSubscription_Examples"></a>

### Example
<a name="API_CreateEventSubscription_Example_1"></a>

This example illustrates one usage of CreateEventSubscription.

#### Sample Request
<a name="API_CreateEventSubscription_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateEventSubscription
   &Enabled=true
   &EventCategories.member.1=failure
   &EventCategories.member.2=configuration%20change
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A802#########%3Amytopic
   &SourceType=db-security-group
   &SubscriptionName=myawsuser-secgrp
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T214325Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=7045960f6ab15609571fb05278004256e186b7633ab2a3ae46826d7713e0b461
```

#### Sample Response
<a name="API_CreateEventSubscription_Example_1_Response"></a>

```
<CreateEventSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateEventSubscriptionResult>
    <EventSubscription>
      <SourceType>db-security-group</SourceType>
      <Enabled>true</Enabled>
      <CustomerAwsId>803#########</CustomerAwsId>
      <Status>creating</Status>
      <SubscriptionCreationTime>Fri Apr 25 21:43:25 UTC 2014</SubscriptionCreationTime>
      <EventCategoriesList>
        <EventCategory>configuration change</EventCategory>
        <EventCategory>failure</EventCategory>
      </EventCategoriesList>
      <CustSubscriptionId>myawsuser-secgrp</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-east-1:802#########:mytopic</SnsTopicArn>
    </EventSubscription>
  </CreateEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>f15e9dc3-bbb1-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</CreateEventSubscriptionResponse>
```

### Example
<a name="API_CreateEventSubscription_Example_2"></a>

This example illustrates one usage of CreateEventSubscription.

#### Sample Request
<a name="API_CreateEventSubscription_Example_2_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateEventSubscription
   &Enabled=true
   &EventCategories.member.1=creation
   &EventCategories.member.2=deletion
   &EventCategories.member.3=failover
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A802#########%3Amytopic
   &SourceType=db-instance
   &SubscriptionName=myawsuser-inst
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request
   &X-Amz-Date=20140429T184410Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=1e1879f20ef3aec07135d69cc192426bf1cc5c42fc9d1acc7726bcd93155fb71
```

#### Sample Response
<a name="API_CreateEventSubscription_Example_2_Response"></a>

```
<CreateEventSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateEventSubscriptionResult>
    <EventSubscription>
      <SourceType>db-instance</SourceType>
      <Enabled>true</Enabled>
      <CustomerAwsId>803#########</CustomerAwsId>
      <Status>creating</Status>
      <SubscriptionCreationTime>Tue Apr 29 18:44:10 UTC 2014</SubscriptionCreationTime>
      <EventCategoriesList>
        <EventCategory>creation</EventCategory>
        <EventCategory>deletion</EventCategory>
        <EventCategory>failover</EventCategory>
      </EventCategoriesList>
      <CustSubscriptionId>myawsuser-inst</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-east-1:802#########:mytopic</SnsTopicArn>
    </EventSubscription>
  </CreateEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>30feb307-bebd-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</CreateEventSubscriptionResponse>
```

## See Also
<a name="API_CreateEventSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateEventSubscription) 

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

Creates an Aurora global database spread across multiple AWS Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

**Note**  
This operation applies only to Aurora DB clusters.

## Request Parameters
<a name="API_CreateGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalClusterIdentifier **   
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** DatabaseName **   
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.  
Constraints:  
+ Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.  
Type: Boolean  
Required: No

 ** Engine **   
The database engine to use for this global database cluster.  
Valid Values: `aurora-mysql | aurora-postgresql`   
Constraints:  
+ Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
Type: String  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this global database cluster.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.  
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*.  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineVersion **   
The engine version to use for this global database cluster.  
Constraints:  
+ Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
Type: String  
Required: No

 ** SourceDBClusterIdentifier **   
The Amazon Resource Name (ARN) to use as the primary cluster of the global database.  
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:  
+  `DatabaseName` 
+  `Engine` 
+  `EngineVersion` 
+  `StorageEncrypted` 
Type: String  
Required: No

 ** StorageEncrypted **   
Specifies whether to enable storage encryption for the new global database cluster.  
Constraints:  
+ Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Type: Boolean  
Required: No

 **Tags.Tag.N**   
Tags to assign to the global cluster.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_CreateGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** GlobalClusterAlreadyExistsFault **   
The `GlobalClusterIdentifier` already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.  
HTTP Status Code: 400

 ** GlobalClusterQuotaExceededFault **   
The number of global database clusters for this account is already at the maximum allowed.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBShardGroupState **   
The DB shard group must be in the available state.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_CreateGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateGlobalCluster) 

# CreateIntegration
<a name="API_CreateIntegration"></a>

Creates a zero-ETL integration with Amazon Redshift.

## Request Parameters
<a name="API_CreateIntegration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** IntegrationName **   
The name of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** SourceArn **   
The Amazon Resource Name (ARN) of the database to use as the source for replication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*`   
Required: Yes

 ** TargetArn **   
The ARN of the Redshift data warehouse to use as the target for replication.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 **AdditionalEncryptionContext** AdditionalEncryptionContext.entry.N.key (key)AdditionalEncryptionContext.entry.N.value (value)  
An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the * AWS Key Management Service Developer Guide*.  
You can only include this parameter if you specify the `KMSKeyId` parameter.  
Type: String to string map  
Required: No

 ** DataFilter **   
Data filtering options for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html) or [Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25600.  
Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*`   
Required: No

 ** Description **   
A description of the integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** KMSKeyId **   
The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.   
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateIntegration_ResponseElements"></a>

The following elements are returned by the service.

 **AdditionalEncryptionContext** AdditionalEncryptionContext.entry.N.key (key)AdditionalEncryptionContext.entry.N.value (value)  
The encryption context for the integration. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the * AWS Key Management Service Developer Guide*.  
Type: String to string map

 ** CreateTime **   
The time when the integration was created, in Universal Coordinated Time (UTC).  
Type: Timestamp

 ** DataFilter **   
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25600.  
Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*` 

 ** Description **   
A description of the integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 **Errors.IntegrationError.N**   
Any errors associated with the integration.  
Type: Array of [IntegrationError](API_IntegrationError.md) objects

 ** IntegrationArn **   
The ARN of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** IntegrationName **   
The name of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** KMSKeyId **   
The AWS Key Management System (AWS KMS) key identifier for the key used to to encrypt the integration.   
Type: String

 ** SourceArn **   
The Amazon Resource Name (ARN) of the database used as the source for replication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** Status **   
The current status of the integration.  
Type: String  
Valid Values: `creating | active | modifying | failed | deleting | syncing | needs_attention` 

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 ** TargetArn **   
The ARN of the Redshift data warehouse used as the target for replication.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

## Errors
<a name="API_CreateIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** IntegrationAlreadyExistsFault **   
The integration you are trying to create already exists.  
HTTP Status Code: 400

 ** IntegrationConflictOperationFault **   
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.  
HTTP Status Code: 400

 ** IntegrationQuotaExceededFault **   
You can't crate any more zero-ETL integrations because the quota has been reached.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

## Examples
<a name="API_CreateIntegration_Examples"></a>

### Example
<a name="API_CreateIntegration_Example_1"></a>

This example illustrates one usage of CreateIntegration.

#### Sample Request
<a name="API_CreateIntegration_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateIntegration
   &IntegrationName=my-integration
   &SourceArn=arn%3Aaws%3Ards%3Aus-east-1%3A123456789012%3Adb%3Asource-db
   &TargetArn=arn%3Aaws%3Aredshift-serverless%3Aus-east-1%3A123456789012%3Anamespace%3A0844171c-1e01-4d9f-be52-89e6c44083e5
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-east-1/rds/aws4_request
   &X-Amz-Date=20230110T005253Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_CreateIntegration_Example_1_Response"></a>

```
<CreateIntegrationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <CreateIntegrationResult>
        <SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:source-db</SourceArn>
        <IntegrationName>my-integration</IntegrationName>
        <IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:f30acbd8-aaab-4c3c-afb5-09d51d041037</IntegrationArn>
        <TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/0844171c-1e01-4d9f-be52-89e6c44083e5</TargetArn>
        <Tags/>
        <CreateTime>2023-12-14T00:15:21.358Z</CreateTime>
        <KMSKeyId>arn:aws:kms:us-east-1:211223847500:key/eda7134d-cd39-4af1-b62b-ad2415b6bccc</KMSKeyId>
        <Status>creating</Status>
    </CreateIntegrationResult>
    <ResponseMetadata>
        <RequestId>f5a16865-4415-4054-890c-2f5b2c3c67a8</RequestId>
    </ResponseMetadata>
</CreateIntegrationResponse>
```

## See Also
<a name="API_CreateIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateIntegration) 

# CreateOptionGroup
<a name="API_CreateOptionGroup"></a>

Creates a new option group. You can create up to 20 option groups.

This command doesn't apply to RDS Custom.

## Request Parameters
<a name="API_CreateOptionGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EngineName **   
The name of the engine to associate this option group with.  
Valid Values:  
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: Yes

 ** MajorEngineVersion **   
Specifies the major version of the engine that this option group should be associated with.  
Type: String  
Required: Yes

 ** OptionGroupDescription **   
The description of the option group.  
Type: String  
Required: Yes

 ** OptionGroupName **   
Specifies the name of the option group to be created.  
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `myoptiongroup`   
Type: String  
Required: Yes

 **Tags.Tag.N**   
Tags to assign to the option group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateOptionGroup_ResponseElements"></a>

The following element is returned by the service.

 ** OptionGroup **   
  
Type: [OptionGroup](API_OptionGroup.md) object

## Errors
<a name="API_CreateOptionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OptionGroupAlreadyExistsFault **   
The option group you are trying to create already exists.  
HTTP Status Code: 400

 ** OptionGroupQuotaExceededFault **   
The quota of 20 option groups was exceeded for this AWS account.  
HTTP Status Code: 400

## Examples
<a name="API_CreateOptionGroup_Examples"></a>

### Example
<a name="API_CreateOptionGroup_Example_1"></a>

This example illustrates one usage of CreateOptionGroup.

#### Sample Request
<a name="API_CreateOptionGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=CreateOptionGroup
   &EngineName=mysql
   &MajorEngineVersion=5.6
   &OptionGroupDescription=My%20Option%20Group
   &OptionGroupName=myawsuser-og00
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T174519Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=d3a89afa4511d0c4ecab046d6dc760a72bfe6bb15999cce053adeb2617b60384
```

#### Sample Response
<a name="API_CreateOptionGroup_Example_1_Response"></a>

```
<CreateOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateOptionGroupResult>
    <OptionGroup>
      <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
      <MajorEngineVersion>5.6</MajorEngineVersion>
      <OptionGroupName>myawsuser-og00</OptionGroupName>
      <EngineName>mysql</EngineName>
      <OptionGroupDescription>My Option Group</OptionGroupDescription>
      <Options/>
    </OptionGroup>
  </CreateOptionGroupResult>
  <ResponseMetadata>
    <RequestId>4d7f11f2-bbf0-11d3-ae4f-eec568ed6b36</RequestId>
  </ResponseMetadata>
</CreateOptionGroupResponse>
```

## See Also
<a name="API_CreateOptionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateOptionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateOptionGroup) 

# CreateTenantDatabase
<a name="API_CreateTenantDatabase"></a>

Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.

## Request Parameters
<a name="API_CreateTenantDatabase_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.  
Type: String  
Required: Yes

 ** MasterUsername **   
The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.  
Constraints:  
+ Must be 1 to 16 letters, numbers, or underscores.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
Type: String  
Required: Yes

 ** TenantDBName **   
The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as `DBName` in `CreateDBInstance`.  
Type: String  
Required: Yes

 ** CharacterSetName **   
The character set for your tenant database. If you don't specify a value, the character set name defaults to `AL32UTF8`.  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUserPassword **   
The password for the master user in your tenant database.  
Constraints:  
+ Must be 8 to 30 characters.
+ Can include any printable ASCII character except forward slash (`/`), double quote (`"`), at symbol (`@`), ampersand (`&`), or single quote (`'`).
+ Can't be specified when `ManageMasterUserPassword` is enabled.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** NcharCharacterSetName **   
The `NCHAR` value for the tenant database.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateTenantDatabase_ResponseElements"></a>

The following element is returned by the service.

 ** TenantDatabase **   
A tenant database in the DB instance. This data type is an element in the response to the `DescribeTenantDatabases` action.  
Type: [TenantDatabase](API_TenantDatabase.md) object

## Errors
<a name="API_CreateTenantDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** TenantDatabaseAlreadyExists **   
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

## See Also
<a name="API_CreateTenantDatabase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/CreateTenantDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/CreateTenantDatabase) 

# DeleteBlueGreenDeployment
<a name="API_DeleteBlueGreenDeployment"></a>

Deletes a blue/green deployment.

For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_DeleteBlueGreenDeployment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BlueGreenDeploymentIdentifier **   
The unique identifier of the blue/green deployment to delete. This parameter isn't case-sensitive.  
Constraints:   
+ Must match an existing blue/green deployment identifier.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** DeleteTarget **   
Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment [status](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html) is `SWITCHOVER_COMPLETED`.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DeleteBlueGreenDeployment_ResponseElements"></a>

The following element is returned by the service.

 ** BlueGreenDeployment **   
Details about a blue/green deployment.  
For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.  
Type: [BlueGreenDeployment](API_BlueGreenDeployment.md) object

## Errors
<a name="API_DeleteBlueGreenDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

 ** InvalidBlueGreenDeploymentStateFault **   
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteBlueGreenDeployment_Examples"></a>

### Example
<a name="API_DeleteBlueGreenDeployment_Example_1"></a>

This example illustrates one usage of DeleteBlueGreenDeployment.

#### Sample Request
<a name="API_DeleteBlueGreenDeployment_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DeleteBlueGreenDeployment
   &BlueGreenDeploymentIdentifier=bgd-mdoyy2mn7vbkhhgg
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-west-2/rds/aws4_request
   &X-Amz-Date=20230110T191150Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_DeleteBlueGreenDeployment_Example_1_Response"></a>

```
<DeleteBlueGreenDeploymentResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteBlueGreenDeploymentResult>
    <BlueGreenDeployment>
      <TagList/>
      <BlueGreenDeploymentName>my-blue-green-deployment</BlueGreenDeploymentName>
      <DeleteTime>2023-01-10T19:11:51.293Z</DeleteTime>
      <CreateTime>2023-01-10T18:42:09.330Z</CreateTime>
      <SwitchoverDetails>
        <member>
          <SourceMember>arn:aws:rds:us-west-2:123456789012:db:database-1-old1</SourceMember>
          <TargetMember>arn:aws:rds:us-west-2:123456789012:db:database-1</TargetMember>
          <Status>SWITCHOVER_COMPLETED</Status>
        </member>
      </SwitchoverDetails>
      <Source>arn:aws:rds:us-west-2:123456789012:db:database-1-old1</Source>
      <BlueGreenDeploymentIdentifier>bgd-mdoyy2mn7vbkhhgg</BlueGreenDeploymentIdentifier>
      <Tasks>
        <member>
          <Name>CREATING_READ_REPLICA_OF_SOURCE</Name>
          <Status>COMPLETED</Status>
        </member>
        <member>
          <Name>CONFIGURE_BACKUPS</Name>
          <Status>COMPLETED</Status>
        </member>
      </Tasks>
      <Target>arn:aws:rds:us-west-2:123456789012:db:database-1</Target>
      <Status>DELETING</Status>
    </BlueGreenDeployment>
  </DeleteBlueGreenDeploymentResult>
  <ResponseMetadata>
    <RequestId>34deffd3-543a-4c26-9ff1-f859894f43bc</RequestId>
  </ResponseMetadata>
</DeleteBlueGreenDeploymentResponse>
```

## See Also
<a name="API_DeleteBlueGreenDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteBlueGreenDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteBlueGreenDeployment) 

# DeleteCustomDBEngineVersion
<a name="API_DeleteCustomDBEngineVersion"></a>

Deletes 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 snapshot, or automated backup of your RDS Custom instance.

Typically, deletion takes a few minutes.

**Note**  
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with AWS CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the `DeleteCustomDbEngineVersion` event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the `DeleteCustomDbEngineVersion` event.

For more information, see [Deleting a CEV](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DeleteCustomDBEngineVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The database engine.  
RDS Custom for Oracle supports the following values:  
+  `custom-oracle-ee` 
+  `custom-oracle-ee-cdb` 
+  `custom-oracle-se2` 
+  `custom-oracle-se2-cdb` 
RDS Custom for SQL Server supports the following values:  
+  `custom-sqlserver-ee` 
+  `custom-sqlserver-se` 
+  `ccustom-sqlserver-web` 
+  `custom-sqlserver-dev` 
RDS for SQL Server supports only `sqlserver-dev-ee`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[A-Za-z0-9-]{1,35}`   
Required: Yes

 ** EngineVersion **   
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of `Engine` and `EngineVersion` is unique per customer per AWS Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `[a-z0-9_.-]{1,60}`   
Required: Yes

## Response Elements
<a name="API_DeleteCustomDBEngineVersion_ResponseElements"></a>

The following elements are returned by the service.

 ** CreateTime **   
The creation time of the DB engine version.  
Type: Timestamp

 ** CustomDBEngineVersionManifest **   
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see [JSON fields in the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) in the *Amazon RDS User Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51000.  
Pattern: `[\s\S]*` 

 **DatabaseInstallationFiles.member.N**   
The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. Required for `sqlserver-dev-ee`.  
Type: Array of strings

 ** DatabaseInstallationFilesS3BucketName **   
The name of the Amazon S3 bucket that contains your database installation files.  
Type: String

 ** DatabaseInstallationFilesS3Prefix **   
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.  
Type: String

 ** DBEngineDescription **   
The description of the database engine.  
Type: String

 ** DBEngineMediaType **   
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.  
Type: String

 ** DBEngineVersionArn **   
The ARN of the custom engine version.  
Type: String

 ** DBEngineVersionDescription **   
The description of the database engine version.  
Type: String

 ** DBParameterGroupFamily **   
The name of the DB parameter group family for the database engine.  
Type: String

 ** DefaultCharacterSet **   
The default character set for new instances of this engine version, if the `CharacterSetName` parameter of the CreateDBInstance API isn't specified.  
Type: [CharacterSet](API_CharacterSet.md) object

 ** Engine **   
The name of the database engine.  
Type: String

 ** EngineVersion **   
The version number of the database engine.  
Type: String

 **ExportableLogTypes.member.N**   
The types of logs that the database engine has available for export to CloudWatch Logs.  
Type: Array of strings

 ** FailureReason **   
The reason that the custom engine version creation for `sqlserver-dev-ee` failed with an `incompatible-installation-media` status.  
Type: String

 ** Image **   
The EC2 image  
Type: [CustomDBEngineVersionAMI](API_CustomDBEngineVersionAMI.md) object

 ** KMSKeyId **   
The AWS KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.  
Type: String

 ** MajorEngineVersion **   
The major engine version of the CEV.  
Type: String

 ** ServerlessV2FeaturesSupport **   
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.   
Type: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) object

 ** Status **   
The status of the DB engine version, either `available` or `deprecated`.  
Type: String

 **SupportedCACertificateIdentifiers.member.N**   
A list of the supported CA certificate identifiers.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: Array of strings

 **SupportedCharacterSets.CharacterSet.N**   
A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedEngineModes.member.N**   
A list of the supported DB engine modes.  
Type: Array of strings

 **SupportedFeatureNames.member.N**   
A list of features supported by the DB engine.  
The supported features vary by DB engine and DB engine version.  
To determine the supported features for a specific DB engine and DB engine version using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>`   
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --engine-version 13.3`   
The supported features are listed under `SupportedFeatureNames` in the output.  
Type: Array of strings

 **SupportedNcharCharacterSets.CharacterSet.N**   
A list of the character sets supported by the Oracle DB engine for the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedTimezones.Timezone.N**   
A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action.  
Type: Array of [Timezone](API_Timezone.md) objects

 ** SupportsBabelfish **   
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.  
Type: Boolean

 ** SupportsCertificateRotationWithoutRestart **   
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.  
Type: Boolean

 ** SupportsGlobalDatabases **   
Indicates whether you can use Aurora global databases with a specific DB engine version.  
Type: Boolean

 ** SupportsIntegrations **   
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.  
Type: Boolean

 ** SupportsLimitlessDatabase **   
Indicates whether the DB engine version supports Aurora Limitless Database.  
Type: Boolean

 ** SupportsLocalWriteForwarding **   
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.  
Valid for: Aurora DB clusters only  
Type: Boolean

 ** SupportsLogExportsToCloudwatchLogs **   
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.  
Type: Boolean

 ** SupportsParallelQuery **   
Indicates whether you can use Aurora parallel query with a specific DB engine version.  
Type: Boolean

 ** SupportsReadReplica **   
Indicates whether the database engine version supports read replicas.  
Type: Boolean

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 **ValidUpgradeTarget.UpgradeTarget.N**   
A list of engine versions that this database engine version can be upgraded to.  
Type: Array of [UpgradeTarget](API_UpgradeTarget.md) objects

## Errors
<a name="API_DeleteCustomDBEngineVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CustomDBEngineVersionNotFoundFault **   
The specified CEV was not found.  
HTTP Status Code: 404

 ** InvalidCustomDBEngineVersionStateFault **   
You can't delete the CEV.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteCustomDBEngineVersion_Examples"></a>

### Example
<a name="API_DeleteCustomDBEngineVersion_Example_1"></a>

This example illustrates one usage of DeleteCustomDBEngineVersion.

#### Sample Request
<a name="API_DeleteCustomDBEngineVersion_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Engine=custom-oracle-ee
    &EngineVersion=19.cev1
    &Operation=DeleteCustomDBEngineVersion
    &Version=1999-01-01
    &AWSAccessKeyId=ABCDEF1GHIJKLMNOPQRSTUV
    &SignatureVersion=2
    &SignatureMethod=HmacSHA1
    &Timestamp=2021-10-13T21%3A37%3A10.000Z
```

#### Sample Response
<a name="API_DeleteCustomDBEngineVersion_Example_1_Response"></a>

```
<DeleteCustomDBEngineVersionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteCustomDBEngineVersionResult>
    <DatabaseInstallationFilesS3Prefix>123456789012/cev1</DatabaseInstallationFilesS3Prefix>
    <MajorEngineVersion>19</MajorEngineVersion>
    <DBEngineVersionArn>arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee/19.cev1/123ab45c-abc1-1234-1234-123a45b12345</DBEngineVersionArn>
    <DBEngineVersionDescription>some text</DBEngineVersionDescription>
    <SupportsGlobalDatabases>false</SupportsGlobalDatabases>
    <SupportsParallelQuery>false</SupportsParallelQuery>
    <Engine>custom-oracle-ee</Engine>
    <KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/12ab3c4d-1234-12a3-1aa2-12a3bcdefghi</KMSKeyId>
    <EngineVersion>19.cev</EngineVersion>
    <SupportsReadReplica>false</SupportsReadReplica>
    <SupportsCluster>false</SupportsCluster>
    <TagList/>
    <CreateTime>2021-10-12T21:51:34.468Z</CreateTime>
    <DatabaseInstallationFilesS3BucketName>1-custom-installation-files</DatabaseInstallationFilesS3BucketName>
    <SupportsLogExportsToCloudwatchLogs>false</SupportsLogExportsToCloudwatchLogs>
    <AMIs>
      <member>
        <Id>ami-0c65ec39d269b9aed</Id>
        <Status>failed</Status>
      </member>
    </AMIs>
    <DBEngineDescription>Oracle Database server EE for RDS Custom</DBEngineDescription>
    <Status>deleting</Status>
  </DeleteCustomDBEngineVersionResult>
  <ResponseMetadata>
    <RequestId>a1234b56-7890-1234-5678-cde90fg1h2i3</RequestId>
  </ResponseMetadata>
</DeleteCustomDBEngineVersionResponse>
```

## See Also
<a name="API_DeleteCustomDBEngineVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteCustomDBEngineVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteCustomDBEngineVersion) 

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DeleteDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.  
Constraints:  
+ Must match an existing DBClusterIdentifier.
Type: String  
Required: Yes

 ** DeleteAutomatedBackups **   
Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.  
Type: Boolean  
Required: No

 ** FinalDBSnapshotIdentifier **   
The DB cluster snapshot identifier of the new DB cluster snapshot created when `SkipFinalSnapshot` is disabled.  
If you specify this parameter and also skip the creation of a final DB cluster snapshot with the `SkipFinalShapshot` parameter, the request results in an error.
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Type: String  
Required: No

 ** SkipFinalSnapshot **   
Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to `true`, RDS doesn't create a final DB cluster snapshot. If you set this value to `false` or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.  
If `SkipFinalSnapshot` is disabled, you must specify a value for the `FinalDBSnapshotIdentifier` parameter.
Type: Boolean  
Required: No

## Response Elements
<a name="API_DeleteDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_DeleteDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAutomatedBackupQuotaExceededFault **   
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.  
HTTP Status Code: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
The user already has a DB cluster snapshot with the given identifier.  
HTTP Status Code: 400

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBCluster_Examples"></a>

### Deleting an Aurora DB cluster
<a name="API_DeleteDBCluster_Example_1"></a>

This example illustrates one usage of DeleteDBCluster.

#### Sample Request
<a name="API_DeleteDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DeleteDBCluster
    &DBClusterIdentifier=sample-cluster2
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140725/us-east-1/rds/aws4_request
    &X-Amz-Date=20140725T162148Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=815910f78c5a9813e1c15300fcf206e04da071b3586770169765292dc6aa2ed4
```

#### Sample Response
<a name="API_DeleteDBCluster_Example_1_Response"></a>

```
<DeleteDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteDBClusterResult>
    <DBCluster>
      <Engine>aurora5.6</Engine>
      <Status>available</Status>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <DBSubnetGroup>my-subgroup</DBSubnetGroup>
      <EngineVersion>5.6.10a</EngineVersion>
      <Endpoint>sample-cluster2.cluster-cbfvmgb0y5fy.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterIdentifier>sample-cluster2</DBClusterIdentifier>
      <PreferredBackupWindow>04:45-05:15</PreferredBackupWindow>
      <PreferredMaintenanceWindow>sat:05:56-sat:06:26</PreferredMaintenanceWindow>
      <DBClusterMembers/>
      <AllocatedStorage>15</AllocatedStorage>
      <MasterUsername>awsuser</MasterUsername>
    </DBCluster>
  </DeleteDBClusterResult>
  <ResponseMetadata>
    <RequestId>c72118dc-1417-11e4-8c7b-931a6c1fef28</RequestId>
  </ResponseMetadata>
</DeleteDBClusterResponse>
```

### Deleting a Multi-AZ DB cluster
<a name="API_DeleteDBCluster_Example_2"></a>

This example illustrates one usage of DeleteDBCluster.

#### Sample Request
<a name="API_DeleteDBCluster_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DeleteDBCluster
    &DBClusterIdentifier=my-multi-az-cluster
    &SkipFinalSnapshot=true
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140725/us-west-2/rds/aws4_request
    &X-Amz-Date=20211027T000821Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=815910f78c5a9813e1c15300fcf206e04da071b3586770169765292dc6aa2ed4
```

#### Sample Response
<a name="API_DeleteDBCluster_Example_2_Response"></a>

```
<DeleteDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteDBClusterResult>
    <DBCluster>
      <CrossAccountClone>false</CrossAccountClone>
      <AllocatedStorage>1000</AllocatedStorage>
      <AssociatedRoles />
      <AvailabilityZones />
      <ReadReplicaIdentifiers />
      <EngineVersion>8.0.26</EngineVersion>
      <MasterUsername>admin</MasterUsername>
      <DBClusterMembers />
      <HttpEndpointEnabled>false</HttpEndpointEnabled>
      <Port>3066</Port>
      <MonitoringInterval>0</MonitoringInterval>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier>
      <DbClusterResourceId>cluster-XDHARXDLDCRL2VZZXKBCFN3RQI</DbClusterResourceId>
      <LatestRestorableTime>2021-08-17T23:15:00Z</LatestRestorableTime>
      <Status>available</Status>
      <PreferredBackupWindow>22:02-22:32</PreferredBackupWindow>
      <DeletionProtection>false</DeletionProtection>
      <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint>
      <EngineMode>provisioned</EngineMode>
      <Engine>mysql</Engine>
      <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint>
      <PubliclyAccessible>true</PubliclyAccessible>
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
      <EarliestRestorableTime>2021-08-16T23:15:00Z</EarliestRestorableTime>
      <ClusterCreateTime>2021-08-10T23:02:10.460Z</ClusterCreateTime>
      <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
      <MultiAZ>false</MultiAZ>
      <DomainMemberships />
      <StorageEncrypted>false</StorageEncrypted>
      <DBSubnetGroup>subnetgroup1</DBSubnetGroup>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <TagList />
      <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId>
      <PreferredMaintenanceWindow>mon:23:02-mon:23:32</PreferredMaintenanceWindow>
      <DBClusterParameterGroup>default.mysql8.0</DBClusterParameterGroup>
      <StorageType>io1</StorageType>
      <DBClusterInstanceClass>db.r6gd.xlarge</DBClusterInstanceClass>
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn>
    </DBCluster>
  </DeleteDBClusterResult>
  <ResponseMetadata>
    <RequestId>08b84e67-7e89-4302-8563-642b34026159</RequestId>
  </ResponseMetadata>
</DeleteDBClusterResponse>
```

## See Also
<a name="API_DeleteDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBCluster) 

# DeleteDBClusterAutomatedBackup
<a name="API_DeleteDBClusterAutomatedBackup"></a>

Deletes automated backups using the `DbClusterResourceId` value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.

## Request Parameters
<a name="API_DeleteDBClusterAutomatedBackup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DbClusterResourceId **   
The identifier for the source DB cluster, which can't be changed and which is unique to an AWS Region.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteDBClusterAutomatedBackup_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterAutomatedBackup **   
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.  
Type: [DBClusterAutomatedBackup](API_DBClusterAutomatedBackup.md) object

## Errors
<a name="API_DeleteDBClusterAutomatedBackup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAutomatedBackupNotFoundFault **   
No automated backup for this DB cluster was found.  
HTTP Status Code: 404

 ** InvalidDBClusterAutomatedBackupStateFault **   
The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDBClusterAutomatedBackup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBClusterAutomatedBackup) 

# DeleteDBClusterEndpoint
<a name="API_DeleteDBClusterEndpoint"></a>

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

**Note**  
This action only applies to Aurora DB clusters.

## Request Parameters
<a name="API_DeleteDBClusterEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterEndpointIdentifier **   
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteDBClusterEndpoint_ResponseElements"></a>

The following elements are returned by the service.

 ** CustomEndpointType **   
The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.  
Type: String

 ** DBClusterEndpointArn **   
The Amazon Resource Name (ARN) for the endpoint.  
Type: String

 ** DBClusterEndpointIdentifier **   
The identifier associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** DBClusterEndpointResourceIdentifier **   
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.  
Type: String

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** Endpoint **   
The DNS address of the endpoint.  
Type: String

 ** EndpointType **   
The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.  
Type: String

 **ExcludedMembers.member.N**   
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.  
Type: Array of strings

 **StaticMembers.member.N**   
List of DB instance identifiers that are part of the custom endpoint group.  
Type: Array of strings

 ** Status **   
The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that can't be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database.  
Type: String

## Errors
<a name="API_DeleteDBClusterEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterEndpointNotFoundFault **   
The specified custom endpoint doesn't exist.  
HTTP Status Code: 400

 ** InvalidDBClusterEndpointStateFault **   
The requested operation can't be performed on the endpoint while the endpoint is in this state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDBClusterEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBClusterEndpoint) 

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DeleteDBClusterParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group.  
Constraints:  
+ Must be the name of an existing DB cluster parameter group.
+ You can't delete a default DB cluster parameter group.
+ Can't be associated with any DB clusters.
Type: String  
Required: Yes

## Errors
<a name="API_DeleteDBClusterParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBClusterParameterGroup_Examples"></a>

### Example
<a name="API_DeleteDBClusterParameterGroup_Example_1"></a>

This example illustrates one usage of DeleteDBClusterParameterGroup.

#### Sample Request
<a name="API_DeleteDBClusterParameterGroup_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DeleteDBClusterParameterGroup
    &DBClusterParameterGroupName=sample-cluster-pg
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
    &X-Amz-Date=20160913T172430Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=3f54b5ee720c2644296e98a1c0393a9abd91bc0847dfe7dd9be02ede8fd95ae5
```

#### Sample Response
<a name="API_DeleteDBClusterParameterGroup_Example_1_Response"></a>

```
<DeleteDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>ee0201e1-79d6-11e6-9b94-838991bd60c6</RequestId>
  </ResponseMetadata>
</DeleteDBClusterParameterGroupResponse>
```

## See Also
<a name="API_DeleteDBClusterParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBClusterParameterGroup) 

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

**Note**  
The DB cluster snapshot must be in the `available` state to be deleted.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DeleteDBClusterSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
The identifier of the DB cluster snapshot to delete.  
Constraints: Must be the name of an existing DB cluster snapshot in the `available` state.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterSnapshot **   
Contains the details for an Amazon RDS DB cluster snapshot  
This data type is used as a response element in the `DescribeDBClusterSnapshots` action.  
Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object

## Errors
<a name="API_DeleteDBClusterSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBClusterSnapshot_Examples"></a>

### Example
<a name="API_DeleteDBClusterSnapshot_Example_1"></a>

This example illustrates one usage of DeleteDBClusterSnapshot.

#### Sample Request
<a name="API_DeleteDBClusterSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DeleteDBClusterSnapshot
    &DBClusterSnapshotIdentifier=sample-cluster-snapshot
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150318/us-east-1/rds/aws4_request
    &X-Amz-Date=20150318T215614Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=7aaab0a295151051bc4723f5b1f7b6b535615b8db9256bd56993c4dc6df4c2c4
```

#### Sample Response
<a name="API_DeleteDBClusterSnapshot_Example_1_Response"></a>

```
<DeleteDBClusterSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteDBClusterSnapshotResult>
    <DBClusterSnapshot>
      <Port>0</Port>
      <Status>available</Status>
      <Engine>aurora</Engine>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>aurora</LicenseModel>
      <DBClusterSnapshotIdentifier>sample-cluster-snapshot</DBClusterSnapshotIdentifier>
      <SnapshotCreateTime>2015-03-18T20:53:22.523Z</SnapshotCreateTime>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <VpcId>vpc-3fabee54</VpcId>
      <ClusterCreateTime>2015-03-06T22:11:13.826Z</ClusterCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>awsuser</MasterUsername>
    </DBClusterSnapshot>
  </DeleteDBClusterSnapshotResult>
  <ResponseMetadata>
    <RequestId>994ab08d-cdb9-2ce4-abf9-7528e6348483</RequestId>
  </ResponseMetadata>
</DeleteDBClusterSnapshotResponse>
```

## See Also
<a name="API_DeleteDBClusterSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBClusterSnapshot) 

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. 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 `deleting` until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use `DescribeDBInstance`.

When a DB instance is in a failure state and has a status of `failed`, `incompatible-restore`, or `incompatible-network`, you can only delete it when you skip creation of the final snapshot with the `SkipFinalSnapshot` parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
+ The DB cluster is a read replica of another Amazon Aurora DB cluster.
+ The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first use the `PromoteReadReplicaDBCluster` operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the `DeleteDBInstance` operation to delete the final instance in the DB cluster.

**Important**  
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.

## Request Parameters
<a name="API_DeleteDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the name of an existing DB instance.
Type: String  
Required: Yes

 ** DeleteAutomatedBackups **   
Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.  
Type: Boolean  
Required: No

 ** FinalDBSnapshotIdentifier **   
The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the `SkipFinalSnapshot` parameter is disabled.  
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.  
Constraints:  
+ Must be 1 to 255 letters or numbers.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
+ Can't be specified when deleting a read replica.
Type: String  
Required: No

 ** SkipFinalSnapshot **   
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.  
If you don't enable this parameter, you must specify the `FinalDBSnapshotIdentifier` parameter.
When a DB instance is in a failure state and has a status of `failed`, `incompatible-restore`, or `incompatible-network`, RDS can delete the instance only if you enable this parameter.  
If you delete a read replica or an RDS Custom instance, you must enable this setting.  
This setting is required for RDS Custom.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DeleteDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_DeleteDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceAutomatedBackupQuotaExceeded **   
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.  
HTTP Status Code: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` is already used by an existing snapshot.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBInstance_Examples"></a>

### Example
<a name="API_DeleteDBInstance_Example_1"></a>

This example illustrates one usage of DeleteDBInstance.

#### Sample Request
<a name="API_DeleteDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteDBInstance
   &DBInstanceIdentifier=mydatabase
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SkipFinalSnapshot=true
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20131109/us-east-1/rds/aws4_request
   &X-Amz-Date=20131109T001924Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=70e774e243c0fbb7ffe84029637005bf543e9e321cdf432c0b272be5687d32d8
```

#### Sample Response
<a name="API_DeleteDBInstance_Example_1_Response"></a>

```
<DeleteDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteDBInstanceResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DBInstanceStatus>deleting</DBInstanceStatus>
      <MultiAZ>false</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mydatabase</DBInstanceIdentifier>
      <PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <ReadReplicaDBInstanceIdentifiers/>
      <LatestRestorableTime>2013-11-09T00:15:00Z</LatestRestorableTime>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <Endpoint>
        <Port>3306</Port>
        <Address>mydatabase.cf037hpkuvjt.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>mysqldb</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <InstanceCreateTime>2011-04-28T23:33:54.909Z</InstanceCreateTime>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
    </DBInstance>
  </DeleteDBInstanceResult>
  <ResponseMetadata>
    <RequestId>7369556f-b70d-11c3-faca-6ba18376ea1b</RequestId>
  </ResponseMetadata>
</DeleteDBInstanceResponse>
```

## See Also
<a name="API_DeleteDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBInstance) 

# DeleteDBInstanceAutomatedBackup
<a name="API_DeleteDBInstanceAutomatedBackup"></a>

Deletes automated backups using the `DbiResourceId` value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

## Request Parameters
<a name="API_DeleteDBInstanceAutomatedBackup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceAutomatedBackupsArn **   
The Amazon Resource Name (ARN) of the automated backups to delete, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** DbiResourceId **   
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.  
Type: String  
Required: No

## Response Elements
<a name="API_DeleteDBInstanceAutomatedBackup_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstanceAutomatedBackup **   
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.  
Type: [DBInstanceAutomatedBackup](API_DBInstanceAutomatedBackup.md) object

## Errors
<a name="API_DeleteDBInstanceAutomatedBackup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceAutomatedBackupNotFound **   
No automated backup for this DB instance was found.  
HTTP Status Code: 404

 ** InvalidDBInstanceAutomatedBackupState **   
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBInstanceAutomatedBackup_Examples"></a>

### Example
<a name="API_DeleteDBInstanceAutomatedBackup_Example_1"></a>

This example illustrates one usage of DeleteDBInstanceAutomatedBackup.

#### Sample Request
<a name="API_DeleteDBInstanceAutomatedBackup_Example_1_Request"></a>

```
 https://rds.us-east-1.amazonaws.com/
 ?Action=DeleteDBInstanceAutomatedBackup
 &DbiResourceId=db-YVS5NRBNHPGJZ3IT3WADXYSWYU
 &SignatureMethod=HmacSHA256
 &SignatureVersion=4
 &Version=2014-10-31
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-east-1/rds/aws4_request
 &X-Amz-Date=20180912T200207Z
 &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
```

### Example
<a name="API_DeleteDBInstanceAutomatedBackup_Example_2"></a>

This example illustrates one usage of DeleteDBInstanceAutomatedBackup.

#### Sample Response
<a name="API_DeleteDBInstanceAutomatedBackup_Example_2_Response"></a>

```
 <DeleteDBInstanceAutomatedBackupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
 <DeleteDBInstanceAutomatedBackupResult>
 <DBInstanceAutomatedBackup>
 <EngineVersion>11.2.0.4.v13</EngineVersion>
 <MasterUsername>admin</MasterUsername>
 <AllocatedStorage>50</AllocatedStorage>
 <InstanceCreateTime>2018-08-17T21:58:30Z</InstanceCreateTime>
 <DbiResourceId>db-YVS5NRBNHPGJZ3IT3WADXYSWYU</DbiResourceId>
 <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:myoracle1</DBInstanceArn>
 <DBInstanceIdentifier>myoracle1</DBInstanceIdentifier>
 <RestoreWindow/>
 <Encrypted>false</Encrypted>
 <Engine>oracle-ee</Engine>
 <Port>1521</Port>
 <LicenseModel>bring-your-own-license</LicenseModel>
 <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
 <StorageType>magnetic</StorageType>
 <OptionGroupName>default:oracle-ee-11-2</OptionGroupName>
 <Region>us-east-1</Region>
 <Status>deleting</Status>
 </DBInstanceAutomatedBackup>
 </DeleteDBInstanceAutomatedBackupResult>
 <ResponseMetadata>
 <RequestId>d1b4b637-3663-49c9-95ef-65e4e2b8e848</RequestId>
 </ResponseMetadata>
 </DeleteDBInstanceAutomatedBackupResponse>
```

## See Also
<a name="API_DeleteDBInstanceAutomatedBackup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBInstanceAutomatedBackup) 

# DeleteDBParameterGroup
<a name="API_DeleteDBParameterGroup"></a>

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

## Request Parameters
<a name="API_DeleteDBParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Constraints:  
+ Must be the name of an existing DB parameter group
+ You can't delete a default DB parameter group
+ Can't be associated with any DB instances
Type: String  
Required: Yes

## Errors
<a name="API_DeleteDBParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBParameterGroup_Examples"></a>

### Example
<a name="API_DeleteDBParameterGroup_Example_1"></a>

This example illustrates one usage of DeleteDBParameterGroup.

#### Sample Request
<a name="API_DeleteDBParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteDBParameterGroup
   &DBParameterGroupName=mydbparamgroup3
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T203550Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=7364d4d88b4200d14da46aac748781a6da08bc18c5fdc468ee18780e6f84b19e
```

#### Sample Response
<a name="API_DeleteDBParameterGroup_Example_1_Response"></a>

```
<DeleteDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>cad6c267-ba25-11d3-fe11-33d33a9bb7e3</RequestId>
  </ResponseMetadata>
</DeleteDBParameterGroupResponse>
```

## See Also
<a name="API_DeleteDBParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBParameterGroup) 

# DeleteDBProxy
<a name="API_DeleteDBProxy"></a>

Deletes an existing DB proxy.

## Request Parameters
<a name="API_DeleteDBProxy_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The name of the DB proxy to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

## Response Elements
<a name="API_DeleteDBProxy_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxy **   
The data structure representing the details of the DB proxy that you delete.  
Type: [DBProxy](API_DBProxy.md) object

## Errors
<a name="API_DeleteDBProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDBProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBProxy) 

# DeleteDBProxyEndpoint
<a name="API_DeleteDBProxyEndpoint"></a>

Deletes 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.

## Request Parameters
<a name="API_DeleteDBProxyEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyEndpointName **   
The name of the DB proxy endpoint to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

## Response Elements
<a name="API_DeleteDBProxyEndpoint_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxyEndpoint **   
The data structure representing the details of the DB proxy endpoint that you delete.  
Type: [DBProxyEndpoint](API_DBProxyEndpoint.md) object

## Errors
<a name="API_DeleteDBProxyEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** InvalidDBProxyEndpointStateFault **   
You can't perform this operation while the DB proxy endpoint is in a particular state.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDBProxyEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBProxyEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBProxyEndpoint) 

# DeleteDBSecurityGroup
<a name="API_DeleteDBSecurityGroup"></a>

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

**Note**  
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-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DeleteDBSecurityGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSecurityGroupName **   
The name of the DB security group to delete.  
You can't delete the default DB security group.
Constraints:  
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
+ Must not be "Default"
Type: String  
Required: Yes

## Errors
<a name="API_DeleteDBSecurityGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** InvalidDBSecurityGroupState **   
The state of the DB security group doesn't allow deletion.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBSecurityGroup_Examples"></a>

### Example
<a name="API_DeleteDBSecurityGroup_Example_1"></a>

This example illustrates one usage of DeleteDBSecurityGroup.

#### Sample Request
<a name="API_DeleteDBSecurityGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteDBSecurityGroup
   &DBSecurityGroupName=mydbsecuritygroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31 
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T203336Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=873c15061fe60b9db8ea63137e5af82b157019696fc3e9764ef2abd9d71c640a
```

#### Sample Response
<a name="API_DeleteDBSecurityGroup_Example_1_Response"></a>

```
<DeleteDBSecurityGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>7aec7454-ba25-11d3-855b-576787000e19</RequestId>
  </ResponseMetadata>
</DeleteDBSecurityGroupResponse>
```

## See Also
<a name="API_DeleteDBSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBSecurityGroup) 

# DeleteDBShardGroup
<a name="API_DeleteDBShardGroup"></a>

Deletes an Aurora Limitless Database DB shard group.

## Request Parameters
<a name="API_DeleteDBShardGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBShardGroupIdentifier **   
The name of the DB shard group to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

## Response Elements
<a name="API_DeleteDBShardGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ComputeRedundancy **   
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
+ 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
Type: Integer

 ** DBClusterIdentifier **   
The name of the primary DB cluster for the DB shard group.  
Type: String

 ** DBShardGroupArn **   
The Amazon Resource Name (ARN) for the DB shard group.  
Type: String

 ** DBShardGroupIdentifier **   
The name of the DB shard group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** DBShardGroupResourceId **   
The AWS Region-unique, immutable identifier for the DB shard group.  
Type: String

 ** Endpoint **   
The connection endpoint for the DB shard group.  
Type: String

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** PubliclyAccessible **   
Indicates whether the DB shard group is publicly accessible.  
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.  
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBShardGroup](API_CreateDBShardGroup.md).  
This setting is only for Aurora Limitless Database.  
Type: Boolean

 ** Status **   
The status of the DB shard group.  
Type: String

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_DeleteDBShardGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBShardGroupState **   
The DB shard group must be in the available state.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDBShardGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBShardGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBShardGroup) 

# DeleteDBSnapshot
<a name="API_DeleteDBSnapshot"></a>

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

**Note**  
The DB snapshot must be in the `available` state to be deleted.

## Request Parameters
<a name="API_DeleteDBSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSnapshotIdentifier **   
The DB snapshot identifier.  
Constraints: Must be the name of an existing DB snapshot in the `available` state.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteDBSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshot **   
Contains the details of an Amazon RDS DB snapshot.  
This data type is used as a response element in the `DescribeDBSnapshots` action.  
Type: [DBSnapshot](API_DBSnapshot.md) object

## Errors
<a name="API_DeleteDBSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBSnapshot_Examples"></a>

### Example
<a name="API_DeleteDBSnapshot_Example_1"></a>

This example illustrates one usage of DeleteDBSnapshot.

#### Sample Request
<a name="API_DeleteDBSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteDBSnapshot
   &DBSnapshotIdentifier=mysqldb-snap-02
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20210623/us-east-1/rds/aws4_request
   &X-Amz-Date=20210623T203337Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=619f04acffeb4b80d2f442526b1c9da79d0b3097151c24f28e83e851d6541414
```

#### Sample Response
<a name="API_DeleteDBSnapshot_Example_1_Response"></a>

```
<DeleteDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Status>deleted</Status>
      <Engine>mysql</Engine>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
      <EngineVersion>5.6.44</EngineVersion>
      <DBSnapshotIdentifier>mysqldb-snap-02</DBSnapshotIdentifier>
      <SnapshotCreateTime>2021-04-27T08:16:05.356Z</SnapshotCreateTime>   
      <OriginalSnapshotCreateTime>2021-04-27T08:16:05.356Z</OriginalSnapshotCreateTime>    
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2021-04-21T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </DeleteDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>7b17b2b1-ba25-11d3-a537-cef97546330c</RequestId>
  </ResponseMetadata>
</DeleteDBSnapshotResponse>
```

## See Also
<a name="API_DeleteDBSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBSnapshot) 

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

Deletes a DB subnet group.

**Note**  
The specified database subnet group must not be associated with any DB instances.

## Request Parameters
<a name="API_DeleteDBSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSubnetGroupName **   
The name of the database subnet group to delete.  
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.  
Example: `mydbsubnetgroup`   
Type: String  
Required: Yes

## Errors
<a name="API_DeleteDBSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** InvalidDBSubnetGroupStateFault **   
The DB subnet group cannot be deleted because it's in use.  
HTTP Status Code: 400

 ** InvalidDBSubnetStateFault **   
The DB subnet isn't in the *available* state.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDBSubnetGroup_Examples"></a>

### Example
<a name="API_DeleteDBSubnetGroup_Example_1"></a>

This example illustrates one usage of DeleteDBSubnetGroup.

#### Sample Request
<a name="API_DeleteDBSubnetGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteDBSubnetGroup
   &DBSubnetGroupName=myawsuser-dbsubnetgroup
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T180721Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=0f461da21ec03527fdc98acba8a11c36863a399065f9b4ff891ab7cb5e70de74
```

#### Sample Response
<a name="API_DeleteDBSubnetGroup_Example_1_Response"></a>

```
<DeleteDBSubnetGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>6295e5ab-bbf3-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</DeleteDBSubnetGroupResponse>
```

## See Also
<a name="API_DeleteDBSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteDBSubnetGroup) 

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

Deletes an RDS event notification subscription.

## Request Parameters
<a name="API_DeleteEventSubscription_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SubscriptionName **   
The name of the RDS event notification subscription you want to delete.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteEventSubscription_ResponseElements"></a>

The following element is returned by the service.

 ** EventSubscription **   
Contains the results of a successful invocation of the `DescribeEventSubscriptions` action.  
Type: [EventSubscription](API_EventSubscription.md) object

## Errors
<a name="API_DeleteEventSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEventSubscriptionState **   
This error can occur if someone else is modifying a subscription. You should retry the action.  
HTTP Status Code: 400

 ** SubscriptionNotFound **   
The subscription name does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DeleteEventSubscription_Examples"></a>

### Example
<a name="API_DeleteEventSubscription_Example_1"></a>

This example illustrates one usage of DeleteEventSubscription.

#### Sample Request
<a name="API_DeleteEventSubscription_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteEventSubscription
   &SignatureMethod=HmacSHA256 
   &SignatureVersion=4
   &SubscriptionName=EventSubscription04
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T203337Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=05aa834e364a9e1a279d44cc955694518fc96fff638c74faa2be45783102e785
```

#### Sample Response
<a name="API_DeleteEventSubscription_Example_1_Response"></a>

```
<DeleteEventSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteEventSubscriptionResult>
    <EventSubscription>
      <Enabled>true</Enabled>
      <CustomerAwsId>803#########</CustomerAwsId>
      <SourceType>db-instance</SourceType>
      <Status>deleting</Status>
      <SourceIdsList>
        <SourceId>mysqldb</SourceId>
      </SourceIdsList>
      <SubscriptionCreationTime>2014-04-22 23:03:19.776</SubscriptionCreationTime>
      <CustSubscriptionId>EventSubscription04</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-east-1:803#########:myawsuser-RDS</SnsTopicArn>
    </EventSubscription>
  </DeleteEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>7b4cf02a-ba25-11d3-a691-857dc0addcc9</RequestId>
  </ResponseMetadata>
</DeleteEventSubscriptionResponse>
```

## See Also
<a name="API_DeleteEventSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteEventSubscription) 

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

**Note**  
This action only applies to Aurora DB clusters.

## Request Parameters
<a name="API_DeleteGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalClusterIdentifier **   
The cluster identifier of the global database cluster being deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

## Response Elements
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_DeleteGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteGlobalCluster) 

# DeleteIntegration
<a name="API_DeleteIntegration"></a>

Deletes a zero-ETL integration with Amazon Redshift.

## Request Parameters
<a name="API_DeleteIntegration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** IntegrationIdentifier **   
The unique identifier of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_:\-\/]+`   
Required: Yes

## Response Elements
<a name="API_DeleteIntegration_ResponseElements"></a>

The following elements are returned by the service.

 **AdditionalEncryptionContext** AdditionalEncryptionContext.entry.N.key (key)AdditionalEncryptionContext.entry.N.value (value)  
The encryption context for the integration. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the * AWS Key Management Service Developer Guide*.  
Type: String to string map

 ** CreateTime **   
The time when the integration was created, in Universal Coordinated Time (UTC).  
Type: Timestamp

 ** DataFilter **   
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25600.  
Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*` 

 ** Description **   
A description of the integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 **Errors.IntegrationError.N**   
Any errors associated with the integration.  
Type: Array of [IntegrationError](API_IntegrationError.md) objects

 ** IntegrationArn **   
The ARN of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** IntegrationName **   
The name of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** KMSKeyId **   
The AWS Key Management System (AWS KMS) key identifier for the key used to to encrypt the integration.   
Type: String

 ** SourceArn **   
The Amazon Resource Name (ARN) of the database used as the source for replication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** Status **   
The current status of the integration.  
Type: String  
Valid Values: `creating | active | modifying | failed | deleting | syncing | needs_attention` 

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 ** TargetArn **   
The ARN of the Redshift data warehouse used as the target for replication.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

## Errors
<a name="API_DeleteIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** IntegrationConflictOperationFault **   
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.  
HTTP Status Code: 400

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

 ** InvalidIntegrationStateFault **   
The integration is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteIntegration_Examples"></a>

### Example
<a name="API_DeleteIntegration_Example_1"></a>

This example illustrates one usage of DeleteIntegration.

#### Sample Request
<a name="API_DeleteIntegration_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteIntegration
   &IntegrationIdentifier=f30acbd8-aaab-4c3c-afb5-09d51d041037
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-east-1/rds/aws4_request
   &X-Amz-Date=20230110T191150Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_DeleteIntegration_Example_1_Response"></a>

```
<DeleteIntegrationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <DeleteIntegrationResult>
        <SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:source-db</SourceArn>
        <IntegrationName>my-integration</IntegrationName>
        <IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:f30acbd8-aaab-4c3c-afb5-09d51d041037</IntegrationArn>
        <TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/0844171c-1e01-4d9f-be52-89e6c44083e5</TargetArn>
        <Tags/>
        <CreateTime>2023-12-14T00:15:21.358Z</CreateTime>
        <KMSKeyId>arn:aws:kms:us-east-1:211223847500:key/eda7134d-cd39-4af1-b62b-ad2415b6bccc</KMSKeyId>
        <Status>deleting</Status>
    </DeleteIntegrationResult>
    <ResponseMetadata>
        <RequestId>eb348bf0-a8f3-40e8-9e59-6c5c5ed31371</RequestId>
    </ResponseMetadata>
</DeleteIntegrationResponse>
```

## See Also
<a name="API_DeleteIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteIntegration) 

# DeleteOptionGroup
<a name="API_DeleteOptionGroup"></a>

Deletes an existing option group.

## Request Parameters
<a name="API_DeleteOptionGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** OptionGroupName **   
The name of the option group to be deleted.  
You can't delete default option groups.
Type: String  
Required: Yes

## Errors
<a name="API_DeleteOptionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOptionGroupStateFault **   
The option group isn't in the *available* state.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_DeleteOptionGroup_Examples"></a>

### Example
<a name="API_DeleteOptionGroup_Example_1"></a>

This example illustrates one usage of DeleteOptionGroup.

#### Sample Request
<a name="API_DeleteOptionGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DeleteOptionGroup
   &OptionGroupName=myawsuser-og00
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T181205Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_DeleteOptionGroup_Example_1_Response"></a>

```
<DeleteOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>0ac9cda2-bbf4-11d3-f92b-31fa5e8dbc99</RequestId>
  </ResponseMetadata>
</DeleteOptionGroupResponse>
```

## See Also
<a name="API_DeleteOptionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteOptionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteOptionGroup) 

# DeleteTenantDatabase
<a name="API_DeleteTenantDatabase"></a>

Deletes 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.

## Request Parameters
<a name="API_DeleteTenantDatabase_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.  
Type: String  
Required: Yes

 ** TenantDBName **   
The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.  
Type: String  
Required: Yes

 ** FinalDBSnapshotIdentifier **   
The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the `SkipFinalSnapshot` parameter is disabled.  
If you enable this parameter and also enable `SkipFinalShapshot`, the command results in an error.
Type: String  
Required: No

 ** SkipFinalSnapshot **   
Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the `FinalDBSnapshotIdentifier` parameter.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DeleteTenantDatabase_ResponseElements"></a>

The following element is returned by the service.

 ** TenantDatabase **   
A tenant database in the DB instance. This data type is an element in the response to the `DescribeTenantDatabases` action.  
Type: [TenantDatabase](API_TenantDatabase.md) object

## Errors
<a name="API_DeleteTenantDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` is already used by an existing snapshot.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** TenantDatabaseNotFound **   
The specified tenant database wasn't found in the DB instance.  
HTTP Status Code: 404

## See Also
<a name="API_DeleteTenantDatabase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeleteTenantDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeleteTenantDatabase) 

# DeregisterDBProxyTargets
<a name="API_DeregisterDBProxyTargets"></a>

Remove the association between one or more `DBProxyTarget` data structures and a `DBProxyTargetGroup`.

## Request Parameters
<a name="API_DeregisterDBProxyTargets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **DBClusterIdentifiers.member.N**   
One or more DB cluster identifiers.  
Type: Array of strings  
Required: No

 **DBInstanceIdentifiers.member.N**   
One or more DB instance identifiers.  
Type: Array of strings  
Required: No

 ** TargetGroupName **   
The identifier of the `DBProxyTargetGroup`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

## Errors
<a name="API_DeregisterDBProxyTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetNotFoundFault **   
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_DeregisterDBProxyTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DeregisterDBProxyTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DeregisterDBProxyTargets) 

# DescribeAccountAttributes
<a name="API_DescribeAccountAttributes"></a>

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command doesn't take any parameters.

## Response Elements
<a name="API_DescribeAccountAttributes_ResponseElements"></a>

The following element is returned by the service.

 **AccountQuotas.AccountQuota.N**   
A list of `AccountQuota` objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.  
Type: Array of [AccountQuota](API_AccountQuota.md) objects

## Errors
<a name="API_DescribeAccountAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeAccountAttributes_Examples"></a>

### Example
<a name="API_DescribeAccountAttributes_Example_1"></a>

This example illustrates one usage of DescribeAccountAttributes.

#### Sample Request
<a name="API_DescribeAccountAttributes_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
        ?Action=DescribeAccountAttributes
        &SignatureMethod=HmacSHA256
        &SignatureVersion=4
        &Version=2014-10-31
        &X-Amz-Algorithm=AWS4-HMAC-SHA256
        &X-Amz-Credential=AKIADQKE4SARGYLE/20141216/us-west-2/rds/aws4_request
        &X-Amz-Date=20141216T192233Z
        &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
        &X-Amz-Signature=b49545dd3c933bdded80655d433d84bf743261ea1bebb33a7922c5c2c5240cd8
```

#### Sample Response
<a name="API_DescribeAccountAttributes_Example_1_Response"></a>

```
<DescribeAccountAttributesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeAccountAttributesResult>
    <AccountQuotaList>
      <AccountQuota>
        <AccountQuotaName>DBInstances</AccountQuotaName>
        <Used>22</Used>
        <Max>40</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>ReservedDBInstances</AccountQuotaName>
        <Used>6</Used>
        <Max>40</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>AllocatedStorage</AccountQuotaName>
        <Used>27459</Used>
        <Max>100000</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>DBSecurityGroupsPerVPC</AccountQuotaName>
        <Used>11</Used>
        <Max>25</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>AuthorizationsPerDBSecurityGroup</AccountQuotaName>
        <Used>10</Used>
        <Max>20</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>DBParameterGroups</AccountQuotaName>
        <Used>40</Used>
        <Max>50</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>ManualSnapshots</AccountQuotaName>
        <Used>32</Used>
        <Max>50</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>EventSubscriptions</AccountQuotaName>
        <Used>3</Used>
        <Max>20</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>DBSubnetGroups</AccountQuotaName>
        <Used>19</Used>
        <Max>20</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>OptionGroups</AccountQuotaName>
        <Used>14</Used>
        <Max>20</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>SubnetsPerDBSubnetGroup</AccountQuotaName>
        <Used>6</Used>
        <Max>20</Max
      </AccountQuota>
      <AccountQuota>
        <AccountQuotaName>ReadReplicasPerMaster</AccountQuotaName>
        <Used>2</Used>
        <Max>5</Max
      </AccountQuota>
      <AccountQuota>
        <Used>1</Used>
        <AccountQuotaName>DBClusterRoles</AccountQuotaName>
        <Max>5</Max>
      </AccountQuota>
    </AccountQuotaList>
  </DescribeAccountAttributesResult>
  <ResponseMetadata>
    <RequestId>0ce48079-68e4-11de-8c8e-eb648410240d</RequestId>
  </ResponseMetadata>
</DescribeAccountAttributesResponse>
```

## See Also
<a name="API_DescribeAccountAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeAccountAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeAccountAttributes) 

# DescribeBlueGreenDeployments
<a name="API_DescribeBlueGreenDeployments"></a>

Describes one or more blue/green deployments.

For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [ Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_DescribeBlueGreenDeployments_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BlueGreenDeploymentIdentifier **   
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.  
Constraints:  
+ Must match an existing blue/green deployment identifier.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more blue/green deployments to describe.  
Valid Values:  
+  `blue-green-deployment-identifier` - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.
+  `blue-green-deployment-name` - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.
+  `source` - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.
+  `target` - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeBlueGreenDeployments` request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints:  
+ Must be a minimum of 20.
+ Can't exceed 100.
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

## Response Elements
<a name="API_DescribeBlueGreenDeployments_ResponseElements"></a>

The following elements are returned by the service.

 **BlueGreenDeployments.member.N**   
A list of blue/green deployments in the current account and AWS Region.  
Type: Array of [BlueGreenDeployment](API_BlueGreenDeployment.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeBlueGreenDeployments` request.  
Type: String

## Errors
<a name="API_DescribeBlueGreenDeployments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeBlueGreenDeployments_Examples"></a>

### Example
<a name="API_DescribeBlueGreenDeployments_Example_1"></a>

This example illustrates one usage of DescribeBlueGreenDeployments.

#### Sample Request
<a name="API_DescribeBlueGreenDeployments_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeBlueGreenDeployments
   &BlueGreenDeploymentIdentifier=bgd-clyvb1zv1geqensv
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-west-2/rds/aws4_request
   &X-Amz-Date=20230110T005253Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_DescribeBlueGreenDeployments_Example_1_Response"></a>

```
<DescribeBlueGreenDeploymentsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeBlueGreenDeploymentsResult>
    <BlueGreenDeployments>
      <member>
        <TagList/>
        <BlueGreenDeploymentName>my-blue-green-deployment</BlueGreenDeploymentName>
        <CreateTime>2023-01-10T20:08:48.940Z</CreateTime>
        <SwitchoverDetails>
          <member>
            <SourceMember>arn:aws:rds:us-west-2:123456789012:db:database-1</SourceMember>
            <TargetMember>arn:aws:rds:us-west-2:123456789012:db:database-1-green-mhv83d</TargetMember>
            <Status>PROVISIONING</Status>
          </member>
        </SwitchoverDetails>
        <Source>arn:aws:rds:us-west-2:123456789012:db:database-1</Source>
        <BlueGreenDeploymentIdentifier>bgd-clyvb1zv1geqensv</BlueGreenDeploymentIdentifier>
        <Tasks>
          <member>
            <Name>CREATING_READ_REPLICA_OF_SOURCE</Name>
            <Status>IN_PROGRESS</Status>
          </member>
          <member>
            <Name>DB_ENGINE_VERSION_UPGRADE</Name>
            <Status>PENDING</Status>
          </member>
          <member>
            <Name>CONFIGURE_BACKUPS</Name>
            <Status>PENDING</Status>
          </member>
        </Tasks>
        <Target>arn:aws:rds:us-west-2:123456789012:db:database-1-green-mhv83d</Target>
        <Status>PROVISIONING</Status>
      </member>
    </BlueGreenDeployments>
  </DescribeBlueGreenDeploymentsResult>
  <ResponseMetadata>
    <RequestId>a534de7b-dc20-4b16-863a-24f456385d3a</RequestId>
  </ResponseMetadata>
</DescribeBlueGreenDeploymentsResponse>
```

## See Also
<a name="API_DescribeBlueGreenDeployments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeBlueGreenDeployments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeBlueGreenDeployments) 

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this AWS account.

For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_DescribeCertificates_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CertificateIdentifier **   
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.  
Constraints:  
+ Must match an existing CertificateIdentifier.
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeCertificates` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeCertificates_ResponseElements"></a>

The following elements are returned by the service.

 **Certificates.Certificate.N**   
The list of `Certificate` objects for the AWS account.  
Type: Array of [Certificate](API_Certificate.md) objects

 ** DefaultCertificateForNewLaunches **   
The default root CA for new databases created by your AWS account. This is either the root CA override set on your AWS account or the system default CA for the Region if no override exists. To override the default CA, use the `ModifyCertificates` operation.  
Type: String

 ** Marker **   
An optional pagination token provided by a previous `DescribeCertificates` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` .  
Type: String

## Errors
<a name="API_DescribeCertificates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeCertificates_Examples"></a>

### Example
<a name="API_DescribeCertificates_Example_1"></a>

This example illustrates one usage of DescribeCertificates.

#### Sample Request
<a name="API_DescribeCertificates_Example_1_Request"></a>

```
https://rds.amazonaws.com/
   ?Action=DescribeCertificates
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141121/us-west-2/rds/aws4_request
   &X-Amz-Date=20141121T164732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
```

#### Sample Response
<a name="API_DescribeCertificates_Example_1_Response"></a>

```
<DescribeCertificatesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
   <DescribeCertificatesResult>
    <Certificates>
      <Certificate>
        <CertificateIdentifier>rdscacertificate</CertificateIdentifier>
        <CertificateType>ca</CertificateType>
        <ThumbPrint>xxxxxxxxxxxx</ThumbPrint>
        <ValidFrom>2010-05-22T01:12:00.000Z</ValidFrom>
        <ValidTill>2014-05-22T01:12:00.000Z</ValidTill>
      </Certificate>
    </Certificates>
   </DescribeCertificatesResult>
   <ResponseMetadata>
    <RequestId>9135fff3-8509-11e0-bd9b-a7b1ece36d51</RequestId>
   </ResponseMetadata>
  </DescribeCertificatesResponse>
```

## See Also
<a name="API_DescribeCertificates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeCertificates) 

# DescribeDBClusterAutomatedBackups
<a name="API_DescribeDBClusterAutomatedBackups"></a>

Displays 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 optional.

## Request Parameters
<a name="API_DescribeDBClusterAutomatedBackups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.  
Type: String  
Required: No

 ** DbClusterResourceId **   
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.  
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies which resources to return based on status.  
Supported filters are the following:  
+  `status` 
  +  `retained` - Automated backups for deleted clusters and after backup replication is stopped.
+  `db-cluster-id` - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
+  `db-cluster-resource-id` - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBClusterAutomatedBackups_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusterAutomatedBackups.DBClusterAutomatedBackup.N**   
A list of `DBClusterAutomatedBackup` backups.  
Type: Array of [DBClusterAutomatedBackup](API_DBClusterAutomatedBackup.md) objects

 ** Marker **   
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBClusterAutomatedBackups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAutomatedBackupNotFoundFault **   
No automated backup for this DB cluster was found.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBClusterAutomatedBackups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterAutomatedBackups) 

# DescribeDBClusterBacktracks
<a name="API_DescribeDBClusterBacktracks"></a>

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

**Note**  
This action only applies to Aurora MySQL DB clusters.

## Request Parameters
<a name="API_DescribeDBClusterBacktracks_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 alphanumeric characters or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster1`   
Type: String  
Required: Yes

 ** BacktrackIdentifier **   
If specified, this value is the backtrack identifier of the backtrack to be described.  
Constraints:  
+ Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see [Universally unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier).
Example: `123e4567-e89b-12d3-a456-426655440000`   
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB clusters to describe. Supported filters include the following:  
+  `db-cluster-backtrack-id` - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
+  `db-cluster-backtrack-status` - Accepts any of the following backtrack status values:
  +  `applying` 
  +  `completed` 
  +  `failed` 
  +  `pending` 

  The results list includes information about only the backtracks identified by these values.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterBacktracks` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBClusterBacktracks_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusterBacktracks.DBClusterBacktrack.N**   
Contains a list of backtracks for the user.  
Type: Array of [DBClusterBacktrack](API_DBClusterBacktrack.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeDBClusterBacktracks` request.  
Type: String

## Errors
<a name="API_DescribeDBClusterBacktracks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterBacktrackNotFoundFault **   
 `BacktrackIdentifier` doesn't refer to an existing backtrack.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBClusterBacktracks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterBacktracks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterBacktracks) 

# DescribeDBClusterEndpoints
<a name="API_DescribeDBClusterEndpoints"></a>

Returns information about endpoints for an Amazon Aurora DB cluster.

**Note**  
This action only applies to Aurora DB clusters.

## Request Parameters
<a name="API_DescribeDBClusterEndpoints_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterEndpointIdentifier **   
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.  
Type: String  
Required: No

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String  
Required: No

 **Filters.Filter.N**   
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format `Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...`. `Name` can be one of: `db-cluster-endpoint-type`, `db-cluster-endpoint-custom-type`, `db-cluster-endpoint-id`, `db-cluster-endpoint-status`. `Values` for the ` db-cluster-endpoint-type` filter can be one or more of: `reader`, `writer`, `custom`. `Values` for the `db-cluster-endpoint-custom-type` filter can be one or more of: `reader`, `any`. `Values` for the `db-cluster-endpoint-status` filter can be one or more of: `available`, `creating`, `deleting`, `inactive`, `modifying`.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterEndpoints` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBClusterEndpoints_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusterEndpoints.DBClusterEndpointList.N**   
Contains the details of the endpoints associated with the cluster and matching any filter conditions.  
Type: Array of [DBClusterEndpoint](API_DBClusterEndpoint.md) objects

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterEndpoints` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBClusterEndpoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBClusterEndpoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterEndpoints) 

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

Returns a list of `DBClusterParameterGroup` descriptions. If a `DBClusterParameterGroupName` parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DescribeDBClusterParameterGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of a specific DB cluster parameter group to return details for.  
Constraints:  
+ If supplied, must match the name of an existing DBClusterParameterGroup.
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusterParameterGroups.DBClusterParameterGroup.N**   
A list of DB cluster parameter groups.  
Type: Array of [DBClusterParameterGroup](API_DBClusterParameterGroup.md) objects

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBClusterParameterGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBClusterParameterGroups_Examples"></a>

### Example
<a name="API_DescribeDBClusterParameterGroups_Example_1"></a>

This example illustrates one usage of DescribeDBClusterParameterGroups.

#### Sample Request
<a name="API_DescribeDBClusterParameterGroups_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeDBClusterParameterGroups
   &MaxRecords=30
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20150318/us-east-1/rds/aws4_request
   &X-Amz-Date=20150318T184307Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=d9922fdf06b86b870c072b896745251ea8b52bad64bf90e30b0e46f1bb488cca
```

#### Sample Response
<a name="API_DescribeDBClusterParameterGroups_Example_1_Response"></a>

```
<DescribeDBClusterParameterGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClusterParameterGroupsResult>
    <DBClusterParameterGroups>
      <DBClusterParameterGroup>
        <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily>
        <Description>Default cluster parameter group for aurora5.6</Description>
        <DBClusterParameterGroupName>default.aurora5.6</DBClusterParameterGroupName>
      </DBClusterParameterGroup>
      <DBClusterParameterGroup>
        <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily>
        <Description>Sample group</Description>
        <DBClusterParameterGroupName>samplegroup</DBClusterParameterGroupName>
      </DBClusterParameterGroup>
      <DBClusterParameterGroup>
        <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily>
        <Description>Custom group</Description>
        <DBClusterParameterGroupName>custom-group</DBClusterParameterGroupName>
      </DBClusterParameterGroup>
    </DBClusterParameterGroups>
  </DescribeDBClusterParameterGroupsResult>
  <ResponseMetadata>
    <RequestId>9e6503d0-cd9e-11e4-ccf9-7528e6a28483</RequestId>
  </ResponseMetadata>
</DescribeDBClusterParameterGroupsResponse>
```

## See Also
<a name="API_DescribeDBClusterParameterGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterParameterGroups) 

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DescribeDBClusterParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of a specific DB cluster parameter group to return parameter details for.  
Constraints:  
+ If supplied, must match the name of an existing DBClusterParameterGroup.
Type: String  
Required: Yes

 **Filters.Filter.N**   
A filter that specifies one or more DB cluster parameters to describe.  
The only supported filter is `parameter-name`. The results list only includes information about the DB cluster parameters with these names.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** Source **   
A specific source to return parameters for.  
Valid Values:  
+  `engine-default` 
+  `system` 
+  `user` 
Type: String  
Required: No

## Response Elements
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **Parameters.Parameter.N**   
Provides a list of parameters for the DB cluster parameter group.  
Type: Array of [Parameter](API_Parameter.md) objects

## Errors
<a name="API_DescribeDBClusterParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBClusterParameters_Examples"></a>

### Example
<a name="API_DescribeDBClusterParameters_Example_1"></a>

This example illustrates one usage of DescribeDBClusterParameters.

#### Sample Request
<a name="API_DescribeDBClusterParameters_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeDBClusterParameters
    &DBClusterParameterGroupName=default.aurora5.6
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20151231/us-west-2/rds/aws4_request
    &X-Amz-Date=20151231T225813Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=cf8b9ab9c4a36bbb5f5043209b1985784a226d132ed61a5c35163c40506e83f7
```

#### Sample Response
<a name="API_DescribeDBClusterParameters_Example_1_Response"></a>

```
<DescribeDBClusterParametersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClusterParametersResult>
    <Parameters>
      <Parameter>
        <ApplyMethod>pending-reboot</ApplyMethod>
        <DataType>integer</DataType>
        <Source>engine-default</Source>
        <IsModifiable>true</IsModifiable>
        <Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>1-65535</AllowedValues>
        <ParameterName>auto_increment_increment</ParameterName>
      </Parameter>
      <Parameter>
        <ApplyMethod>pending-reboot</ApplyMethod>
        <DataType>integer</DataType>
        <Source>engine-default</Source>
        <IsModifiable>true</IsModifiable>
        <Description>Determines the starting point for the AUTO_INCREMENT column value</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>1-65535</AllowedValues>
        <ParameterName>auto_increment_offset</ParameterName>
      </Parameter>
      <Parameter>
        <ApplyMethod>pending-reboot</ApplyMethod>
        <DataType>string</DataType>
        <Source>engine-default</Source>
        <IsModifiable>true</IsModifiable>
        <Description>When enabled, this variable causes the master to write a checksum for each event in the binary log.</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>NONE,CRC32</AllowedValues>
        <ParameterName>binlog_checksum</ParameterName>
      </Parameter>
      <Parameter>
        <ParameterValue>OFF</ParameterValue>
        <ApplyMethod>pending-reboot</ApplyMethod>
        <DataType>string</DataType>
        <Source>system</Source>
        <IsModifiable>true</IsModifiable>
        <Description>Binary logging format for replication</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>ROW,STATEMENT,MIXED,OFF</AllowedValues>
        <ParameterName>binlog_format</ParameterName>
      </Parameter>
      <Parameter>
        <ApplyMethod>pending-reboot</ApplyMethod>
        <DataType>string</DataType>
        <Source>engine-default</Source>
        <IsModifiable>false</IsModifiable>
        <Description>Whether the server logs full or minimal rows with row-based replication.</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>full,minimal,noblob</AllowedValues>
        <ParameterName>binlog_row_image</ParameterName>
      </Parameter>
    </Parameters>
  </DescribeDBClusterParametersResult>
  <ResponseMetadata>
    <RequestId>c4e42d91-cb92-11e5-895a-99e063757579</RequestId>
  </ResponseMetadata>
</DescribeDBClusterParametersResponse>
```

## See Also
<a name="API_DescribeDBClusterParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterParameters) 

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

Describes 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?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

## Request Parameters
<a name="API_DescribeDBClusters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match an existing DB cluster identifier.
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB clusters to describe.  
Supported Filters:  
+  `clone-group-id` - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
+  `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
+  `db-cluster-resource-id` - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
+  `domain` - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
+  `engine` - Accepts engine names. The results list only includes information about the DB clusters for these engines.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IncludeShared **   
Specifies whether the output includes information about clusters shared from other AWS accounts.  
Type: Boolean  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBClusters_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusters.DBCluster.N**   
Contains a list of DB clusters for the user.  
Type: Array of [DBCluster](API_DBCluster.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeDBClusters` request.  
Type: String

## Errors
<a name="API_DescribeDBClusters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBClusters_Examples"></a>

### Describing an Aurora DB cluster
<a name="API_DescribeDBClusters_Example_1"></a>

This example illustrates one usage of DescribeDBClusters.

#### Sample Request
<a name="API_DescribeDBClusters_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeDBClusters
    &MaxRecords=100
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230222/us-east-1/rds/aws4_request
    &X-Amz-Date=20230222T200807Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_DescribeDBClusters_Example_1_Response"></a>

```
<DescribeDBClustersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClustersResult>
    <DBClusters>
      <DBCluster>
        <AssociatedRoles>
          <DBClusterRole>
            <RoleArn>arn:aws:iam::123456789012:role/sample-role</RoleArn>
            <Status>ACTIVE</Status>
          </DBClusterRole>
        </AssociatedRoles>
        <Engine>aurora-mysql</Engine>
        <Status>available</Status>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBSubnetGroup>my-subgroup</DBSubnetGroup>
        <EngineVersion>8.0.mysql_aurora.3.01.0</EngineVersion>
        <Endpoint>sample-cluster2.cluster-cbfvmgb0y5fy.us-east-1.rds.amazonaws.com</Endpoint>
        <DBClusterIdentifier>sample-cluster2</DBClusterIdentifier>
        <PreferredBackupWindow>04:45-05:15</PreferredBackupWindow>
        <PreferredMaintenanceWindow>sat:05:56-sat:06:26</PreferredMaintenanceWindow>
        <DBClusterMembers/>
        <AllocatedStorage>15</AllocatedStorage>
        <MasterUsername>awsuser</MasterUsername>
      </DBCluster>
      <DBCluster>
        <AssociatedRoles />
        <Engine>aurora-mysql</Engine>
        <Status>available</Status>
        <BackupRetentionPeriod>0</BackupRetentionPeriod>
        <DBSubnetGroup>my-subgroup</DBSubnetGroup>
        <EngineVersion>8.0.mysql_aurora.3.01.0</EngineVersion>
        <Endpoint>sample-cluster3.cluster-cefgqfx9y5fy.us-east-1.rds.amazonaws.com</Endpoint>
        <DBClusterIdentifier>sample-cluster3</DBClusterIdentifier>
        <PreferredBackupWindow>07:06-07:36</PreferredBackupWindow>
        <PreferredMaintenanceWindow>tue:10:18-tue:10:48</PreferredMaintenanceWindow>
        <DBClusterMembers>
          <DBClusterMember>
            <IsClusterWriter>true</IsClusterWriter>
            <DBInstanceIdentifier>sample-cluster3-master</DBInstanceIdentifier>
          </DBClusterMember>
          <DBClusterMember>
            <IsClusterWriter>false</IsClusterWriter>
            <DBInstanceIdentifier>sample-cluster3-read1</DBInstanceIdentifier>
          </DBClusterMember>
        </DBClusterMembers>
        <AllocatedStorage>15</AllocatedStorage>
        <MasterUsername>awsuser</MasterUsername>
      </DBCluster>
    </DBClusters>
  </DescribeDBClustersResult>
  <ResponseMetadata>
    <RequestId>d682b02c-1383-11b4-a6bb-172dfac7f170</RequestId>
  </ResponseMetadata>
</DescribeDBClustersResponse>
```

### Describing a Multi-AZ DB cluster
<a name="API_DescribeDBClusters_Example_2"></a>

This example illustrates one usage of DescribeDBClusters.

#### Sample Request
<a name="API_DescribeDBClusters_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeDBClusters
    &DBClusterIdentifier=my-multi-az-cluster
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140722/us-west-2/rds/aws4_request
    &X-Amz-Date=20211026T203316Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_DescribeDBClusters_Example_2_Response"></a>

```
<DescribeDBClustersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> 
  <DescribeDBClustersResult> 
    <DBClusters> 
      <DBCluster> 
        <CrossAccountClone>false</CrossAccountClone> 
        <AllocatedStorage>100</AllocatedStorage> 
        <DatabaseName>mydb</DatabaseName> 
        <AssociatedRoles /> 
        <AvailabilityZones> 
          <AvailabilityZone>us-west-2a</AvailabilityZone> 
          <AvailabilityZone>us-west-2b</AvailabilityZone> 
          <AvailabilityZone>us-west-2c</AvailabilityZone> 
        </AvailabilityZones> 
        <ReadReplicaIdentifiers /> 
        <Iops>1000</Iops> 
        <PerformanceInsightsKMSKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</PerformanceInsightsKMSKeyId> 
        <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod> 
        <EngineVersion>8.0.26</EngineVersion> 
        <MasterUsername>admin</MasterUsername> 
        <DBClusterMembers> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-3</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>false</IsClusterWriter> 
          </DBClusterMember> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>false</IsClusterWriter> 
          </DBClusterMember> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>true</IsClusterWriter> 
          </DBClusterMember> 
        </DBClusterMembers> 
        <DBActivityStreamStatus>stopped</DBActivityStreamStatus> 
        <HttpEndpointEnabled>false</HttpEndpointEnabled> 
        <Port>3306</Port> 
        <MonitoringInterval>30</MonitoringInterval> 
        <BackupRetentionPeriod>2</BackupRetentionPeriod> 
        <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId> 
        <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier> 
        <DbClusterResourceId>cluster-TSW4QJNKY3P2DNDRR523BDGEIU</DbClusterResourceId> 
        <Status>creating</Status> 
        <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow> 
        <DeletionProtection>false</DeletionProtection> 
        <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint> 
        <EngineMode>provisioned</EngineMode> 
        <Engine>mysql</Engine> 
        <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint> 
        <PubliclyAccessible>true</PubliclyAccessible> 
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled> 
        <ClusterCreateTime>2021-10-26T20:31:54.943Z</ClusterCreateTime> 
        <ActivityStreamStatus>stopped</ActivityStreamStatus> 
        <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled> 
        <MultiAZ>true</MultiAZ> 
        <DomainMemberships /> 
        <MonitoringRoleArn>arn:aws:iam::123456789012:role/enhance-monitoring-role</MonitoringRoleArn> 
        <StorageEncrypted>true</StorageEncrypted> 
        <DBSubnetGroup>mysubnet1</DBSubnetGroup> 
        <VpcSecurityGroups> 
          <VpcSecurityGroupMembership> 
            <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId> 
            <Status>active</Status> 
          </VpcSecurityGroupMembership> 
        </VpcSecurityGroups> 
        <TagList /> 
        <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId> 
        <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow> 
        <DBClusterParameterGroup>my-cluster-param-1</DBClusterParameterGroup> 
        <StorageType>io1</StorageType> 
        <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass> 
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot> 
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
        <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn> 
      </DBCluster> 
    </DBClusters> 
  </DescribeDBClustersResult> 
  <ResponseMetadata> 
    <RequestId>ae8b2342-55d7-4cf0-b7b3-f24e681ce7b9</RequestId> 
  </ResponseMetadata> 
</DescribeDBClustersResponse>
```

### Describing a DB cluster with Internet Access Gateway, and disabled VPC Networking
<a name="API_DescribeDBClusters_Example_3"></a>

This example illustrates one usage of DescribeDBClusters.

#### Sample Request
<a name="API_DescribeDBClusters_Example_3_Request"></a>

```
                    https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeDBClusters
    &DBClusterIdentifier=testvalidation-cluster-3
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20260309/us-east-1/rds/aws4_request
    &X-Amz-Date=20260309T205322Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_DescribeDBClusters_Example_3_Response"></a>

```
                    <DescribeDBClustersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClustersResult>
    <DBClusters>
      <DBCluster>
        <AllocatedStorage>1</AllocatedStorage>
        <AvailabilityZones>
          <AvailabilityZone>us-east-1d</AvailabilityZone>
          <AvailabilityZone>us-east-1a</AvailabilityZone>
          <AvailabilityZone>us-east-1c</AvailabilityZone>
        </AvailabilityZones>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBClusterIdentifier>testvalidation-cluster-3</DBClusterIdentifier>
        <DBClusterParameterGroup>default.aurora-postgresql17</DBClusterParameterGroup>
        <Status>available</Status>
        <MultiAZ>false</MultiAZ>
        <Engine>aurora-postgresql</Engine>
        <EngineVersion>17.4</EngineVersion>
        <Port>5432</Port>
        <MasterUsername>postgres</MasterUsername>
        <PreferredBackupWindow>07:13-07:43</PreferredBackupWindow>
        <PreferredMaintenanceWindow>mon:07:55-mon:08:25</PreferredMaintenanceWindow>
        <DBClusterMembers/>
        <VpcSecurityGroups/>
        <StorageEncrypted>false</StorageEncrypted>
        <DbClusterResourceId>cluster-AHX35HFI2YV26F3XVXVVO3MEHU</DbClusterResourceId>
        <DBClusterArn>arn:aws:rds:us-east-1:634686195229:cluster:testvalidation-cluster-3</DBClusterArn>
        <AssociatedRoles/>
        <IAMDatabaseAuthenticationEnabled>true</IAMDatabaseAuthenticationEnabled>
        <ClusterCreateTime>2026-03-09T20:53:24.054Z</ClusterCreateTime>
        <EngineMode>provisioned</EngineMode>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <DeletionProtection>false</DeletionProtection>
        <HttpEndpointEnabled>false</HttpEndpointEnabled>
        <DBActivityStreamStatus>stopped</DBActivityStreamStatus>
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
        <CrossAccountClone>false</CrossAccountClone>
        <ServerlessV2ScalingConfiguration>
          <MinCapacity>1.0</MinCapacity>
          <MaxCapacity>128.0</MaxCapacity>
        </ServerlessV2ScalingConfiguration>
        <VPCNetworkingEnabled>false</VPCNetworkingEnabled>
        <InternetAccessGatewayEnabled>true</InternetAccessGatewayEnabled>
      </DBCluster>
    </DBClusters>
  </DescribeDBClustersResult>
  <ResponseMetadata>
    <RequestId>f193c741-2294-22c5-b7cc-283efbd8g281</RequestId>
  </ResponseMetadata>
</DescribeDBClustersResponse>
```

## See Also
<a name="API_DescribeDBClusters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusters) 

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If `all` is included in the list of values for the `restore` attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the `ModifyDBClusterSnapshotAttribute` API action.

## Request Parameters
<a name="API_DescribeDBClusterSnapshotAttributes_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
The identifier for the DB cluster snapshot to describe the attributes for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterSnapshotAttributesResult **   
Contains the results of a successful call to the `DescribeDBClusterSnapshotAttributes` API action.  
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the `ModifyDBClusterSnapshotAttribute` API action.  
Type: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) object

## Errors
<a name="API_DescribeDBClusterSnapshotAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBClusterSnapshotAttributes_Examples"></a>

### Example
<a name="API_DescribeDBClusterSnapshotAttributes_Example_1"></a>

This example illustrates one usage of DescribeDBClusterSnapshotAttributes.

#### Sample Request
<a name="API_DescribeDBClusterSnapshotAttributes_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeDBClusterSnapshotAttributes
    &DBClusterSnapshotIdentifier=manual-cluster-snapshot1
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230227/us-east-1/rds/aws4_request
    &X-Amz-Date=20230227T210706Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=27413f450dfac3d68b2197453e52109bacd3863f9df1a02d6e40022165bb2e09
```

#### Sample Response
<a name="API_DescribeDBClusterSnapshotAttributes_Example_1_Response"></a>

```
<DescribeDBClusterSnapshotAttributesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClusterSnapshotAttributesResult>
    <DBClusterSnapshotAttributesResult>
      <DBClusterSnapshotAttributes>
        <DBClusterSnapshotAttribute>
          <AttributeName>restore</AttributeName>
          <AttributeValues>
            <AttributeValue>012345678901</AttributeValue>
          </AttributeValues>
        </DBClusterSnapshotAttribute>
      </DBClusterSnapshotAttributes>
      <DBSnapshotIdentifier>manual-cluster-snapshot1</DBSnapshotIdentifier>
    </DBClusterSnapshotAttributesResult>
  </DescribeDBClusterSnapshotAttributesResult>
  <ResponseMetadata>
    <RequestId>ae5be4a2-7cee-11e5-a056-f1c189649a47</RequestId>
  </ResponseMetadata>
</DescribeDBClusterSnapshotAttributesResponse>
```

## See Also
<a name="API_DescribeDBClusterSnapshotAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterSnapshotAttributes) 

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the `DBClusterSnapshotIdentifier` parameter. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match the identifier of an existing DBCluster.
Type: String  
Required: No

 ** DbClusterResourceId **   
A specific DB cluster resource ID to describe.  
Type: String  
Required: No

 ** DBClusterSnapshotIdentifier **   
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the `DBClusterIdentifier` parameter. This value is stored as a lowercase string.  
Constraints:  
+ If supplied, must match the identifier of an existing DBClusterSnapshot.
+ If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified.
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB cluster snapshots to describe.  
Supported filters:  
+  `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
+  `db-cluster-snapshot-id` - Accepts DB cluster snapshot identifiers.
+  `snapshot-type` - Accepts types of DB cluster snapshots.
+  `engine` - Accepts names of database engines.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IncludePublic **   
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.  
You can share a manual DB cluster snapshot as public by using the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action.  
Type: Boolean  
Required: No

 ** IncludeShared **   
Specifies whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.  
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the `ModifyDBClusterSnapshotAttribute` API action.  
Type: Boolean  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** SnapshotType **   
The type of DB cluster snapshots to be returned. You can specify one of the following values:  
+  `automated` - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
+  `manual` - Return all DB cluster snapshots that have been taken by my AWS account.
+  `shared` - Return all manual DB cluster snapshots that have been shared to my AWS account.
+  `public` - Return all DB cluster snapshots that have been marked as public.
If you don't specify a `SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the `IncludeShared` parameter. You can include public DB cluster snapshots with these results by enabling the `IncludePublic` parameter.  
The `IncludeShared` and `IncludePublic` parameters don't apply for `SnapshotType` values of `manual` or `automated`. The `IncludePublic` parameter doesn't apply when `SnapshotType` is set to `shared`. The `IncludeShared` parameter doesn't apply when `SnapshotType` is set to `public`.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

The following elements are returned by the service.

 **DBClusterSnapshots.DBClusterSnapshot.N**   
Provides a list of DB cluster snapshots for the user.  
Type: Array of [DBClusterSnapshot](API_DBClusterSnapshot.md) objects

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBClusterSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBClusterSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBClusterSnapshots_Examples"></a>

### Example
<a name="API_DescribeDBClusterSnapshots_Example_1"></a>

This example illustrates one usage of DescribeDBClusterSnapshots.

#### Sample Request
<a name="API_DescribeDBClusterSnapshots_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeDBClusterSnapshots
    &IncludePublic=false
    &IncludeShared=true
    &MaxRecords=40
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230218/us-east-1/rds/aws4_request
    &X-Amz-Date=20230218T204210Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=913f0ec1dfc684ff9c6ef3eab5885258dbb22017c47b1bcd4fed4680e35aef4b
```

#### Sample Response
<a name="API_DescribeDBClusterSnapshots_Example_1_Response"></a>

```
<DescribeDBClusterSnapshotsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBClusterSnapshotsResult>
    <DBClusterSnapshots>
      <DBClusterSnapshot>
        <Port>0</Port>
        <Status>available</Status>
        <Engine>aurora-mysql</Engine>
        <SnapshotType>manual</SnapshotType>
        <LicenseModel>aurora</LicenseModel>
        <DBClusterSnapshotIdentifier>sample-cluster-snapshot1</DBClusterSnapshotIdentifier>
        <SnapshotCreateTime>2022-10-12T17:42:48.271Z</SnapshotCreateTime>
        <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
        <VpcId>vpc-3fabee54</VpcId>
        <ClusterCreateTime>2023-02-06T22:11:13.826Z</ClusterCreateTime>
        <PercentProgress>100</PercentProgress>
        <AllocatedStorage>1</AllocatedStorage>
        <MasterUsername>awsuser</MasterUsername>
      </DBClusterSnapshot>
      <DBClusterSnapshot>
        <Port>0</Port>
        <Status>creating</Status>
        <Engine>aurora-mysql</Engine>
        <SnapshotType>automated</SnapshotType>
        <LicenseModel>aurora</LicenseModel>
        <DBClusterSnapshotIdentifier>rds:sample2-cluster-2022-10-22-03-12</DBClusterSnapshotIdentifier>
        <SnapshotCreateTime>2022-10-22T03:12:09.445Z</SnapshotCreateTime>
        <DBClusterIdentifier>sample2-cluster</DBClusterIdentifier>
        <VpcId>vpc-3fabee54</VpcId>
        <ClusterCreateTime>2023-02-16T18:44:13.633Z</ClusterCreateTime>
        <PercentProgress>0</PercentProgress>
        <AllocatedStorage>1</AllocatedStorage>
        <MasterUsername>awsuser</MasterUsername>
      </DBClusterSnapshot>
      <DBClusterSnapshot>
        <Port>0</Port>
        <Status>creating</Status>
        <Engine>aurora-mysql</Engine>
        <SnapshotType>automated</SnapshotType>
        <LicenseModel>aurora</LicenseModel>
        <DBClusterSnapshotIdentifier>rds:sample-cluster-2014-10-22-08-27</DBClusterSnapshotIdentifier>
        <SnapshotCreateTime>2014-10-22T08:27:08.435Z</SnapshotCreateTime>
        <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
        <VpcId>vpc-3fabee54</VpcId>
        <ClusterCreateTime>2014-10-16T20:11:04.016Z</ClusterCreateTime>
        <PercentProgress>0</PercentProgress>
        <AllocatedStorage>1</AllocatedStorage>
        <MasterUsername>awsuser</MasterUsername>
      </DBClusterSnapshot>
     </DBClusterSnapshots>
  </DescribeDBClusterSnapshotsResult>
  <ResponseMetadata>
    <RequestId>3ff63be1-ceef-11e4-840b-459216ffcb55</RequestId>
  </ResponseMetadata>
</DescribeDBClusterSnapshotsResponse>
```

## See Also
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBClusterSnapshots) 

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

Describes the properties of specific versions of DB engines.

## Request Parameters
<a name="API_DescribeDBEngineVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupFamily **   
The name of a specific DB parameter group family to return details for.  
Constraints:  
+ If supplied, must match an existing DB parameter group family.
Type: String  
Required: No

 ** DefaultOnly **   
Specifies whether to return only the default version of the specified engine or the engine and major version combination.  
Type: Boolean  
Required: No

 ** Engine **   
The database engine to return version details for.  
Valid Values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `custom-oracle-ee` 
+  `custom-oracle-ee-cdb` 
+  `custom-oracle-se2` 
+  `custom-oracle-se2-cdb` 
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: No

 ** EngineVersion **   
A specific database engine version to return details for.  
Example: `5.1.49`   
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB engine versions to describe.  
Supported filters:  
+  `db-parameter-group-family` - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
+  `engine` - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
+  `engine-mode` - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
  +  `global` 
  +  `multimaster` 
  +  `parallelquery` 
  +  `provisioned` 
  +  `serverless` 
+  `engine-version` - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
+  `status` - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
  +  `available` 
  +  `deprecated` 
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IncludeAll **   
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.  
Type: Boolean  
Required: No

 ** ListSupportedCharacterSets **   
Specifies whether to list the supported character sets for each engine version.  
If this parameter is enabled and the requested engine supports the `CharacterSetName` parameter for `CreateDBInstance`, the response includes a list of supported character sets for each engine version.  
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.  
Type: Boolean  
Required: No

 ** ListSupportedTimezones **   
Specifies whether to list the supported time zones for each engine version.  
If this parameter is enabled and the requested engine supports the `TimeZone` parameter for `CreateDBInstance`, the response includes a list of supported time zones for each engine version.  
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.  
Type: Boolean  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

The following elements are returned by the service.

 **DBEngineVersions.DBEngineVersion.N**   
A list of `DBEngineVersion` elements.  
Type: Array of [DBEngineVersion](API_DBEngineVersion.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBEngineVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeDBEngineVersions_Examples"></a>

### Example
<a name="API_DescribeDBEngineVersions_Example_1"></a>

This example illustrates one usage of DescribeDBEngineVersions.

#### Sample Request
<a name="API_DescribeDBEngineVersions_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBEngineVersions
   &MaxRecords=100 
   &SignatureMethod=HmacSHA256 
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4772d17a4c43bcd209ff42a0778dd23e73f8434253effd7ac53b89ade3dad45f
```

#### Sample Response
<a name="API_DescribeDBEngineVersions_Example_1_Response"></a>

```
<DescribeDBEngineVersionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBEngineVersionsResult>
    <DBEngineVersions>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.57</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.57</DBEngineVersionDescription>
      </DBEngineVersion>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.61</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.61</DBEngineVersionDescription>
      </DBEngineVersion>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.62</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.62</DBEngineVersionDescription>
      </DBEngineVersion>
  </DescribeDBEngineVersionsResult>
  <ResponseMetadata>
    <RequestId>b74d2635-b98c-11d3-fbc7-5c0aad74da7c</RequestId>
  </ResponseMetadata>
</DescribeDBEngineVersionsResponse>
```

## See Also
<a name="API_DescribeDBEngineVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBEngineVersions) 

# DescribeDBInstanceAutomatedBackups
<a name="API_DescribeDBInstanceAutomatedBackups"></a>

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the `DescribeDBInstanceAutomatedBackups` and `DescribeDBInstances` operations.

All parameters are optional.

## Request Parameters
<a name="API_DescribeDBInstanceAutomatedBackups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceAutomatedBackupsArn **   
The Amazon Resource Name (ARN) of the replicated automated backups, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** DBInstanceIdentifier **   
(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.  
Type: String  
Required: No

 ** DbiResourceId **   
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.  
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies which resources to return based on status.  
Supported filters are the following:  
+  `status` 
  +  `active` - Automated backups for current instances.
  +  `creating` - Automated backups that are waiting for the first automated snapshot to be available.
  +  `retained` - Automated backups for deleted instances and after backup replication is stopped.
+  `db-instance-id` - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
+  `dbi-resource-id` - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBInstanceAutomatedBackups_ResponseElements"></a>

The following elements are returned by the service.

 **DBInstanceAutomatedBackups.DBInstanceAutomatedBackup.N**   
A list of `DBInstanceAutomatedBackup` instances.  
Type: Array of [DBInstanceAutomatedBackup](API_DBInstanceAutomatedBackup.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBInstanceAutomatedBackups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceAutomatedBackupNotFound **   
No automated backup for this DB instance was found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBInstanceAutomatedBackups_Examples"></a>

### Example
<a name="API_DescribeDBInstanceAutomatedBackups_Example_1"></a>

This example illustrates one usage of DescribeDBInstanceAutomatedBackups.

#### Sample Request
<a name="API_DescribeDBInstanceAutomatedBackups_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
?Action=DescribeDBInstanceAutomatedBackups
&MaxRecords=100
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-east-1/rds/aws4_request
&X-Amz-Date=20180912T200207Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=caa44629fa60576c2c282d9b74d47647f9e9f229f6d0e52db1d3be0d095743b0
```

#### Sample Response
<a name="API_DescribeDBInstanceAutomatedBackups_Example_1_Response"></a>

```
<DescribeDBInstanceAutomatedBackupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<DescribeDBInstanceAutomatedBackupsResult>
<DBInstanceAutomatedBackups>
  <DBInstanceAutomatedBackup>DeleteDBInstanceAutomatedBackupResultDeleteDBInstanceAutomatedBackupResult
    <EngineVersion>11.2.0.4.v13</EngineVersion>
    <MasterUsername>admin</MasterUsername>
    <AllocatedStorage>50</AllocatedStorage>
    <InstanceCreateTime>2018-08-17T21:58:30Z</InstanceCreateTime>
    <DbiResourceId>db-IXRXA2XS7KFFA6JWYYWFZEBJDE</DbiResourceId>
    <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:myoracle1</DBInstanceArn>
    <DBInstanceIdentifier>myoracle1</DBInstanceIdentifier>
    <RestoreWindow/>
    <Encrypted>false</Encrypted>
    <Engine>oracle-ee</Engine>
    <Port>1521</Port>
    <LicenseModel>bring-your-own-license</LicenseModel>
    <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
    <StorageType>magnetic</StorageType>
    <OptionGroupName>default:oracle-ee-11-2</OptionGroupName>
    <Region>us-east-1</Region>
    <Status>creating</Status>
  </DBInstanceAutomatedBackup>
  <DBInstanceAutomatedBackup>
    <EngineVersion>11.2.0.4.v12</EngineVersion>
    <MasterUsername>admin</MasterUsername>
    <AllocatedStorage>50</AllocatedStorage>
    <InstanceCreateTime>2018-08-21T00:32:55Z</InstanceCreateTime>
    <AvailabilityZone>us-east-1d</AvailabilityZone>
    <DbiResourceId>db-YVS5NRBNHPGJZ3IT3WADXYSWYU</DbiResourceId>
    <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:myoracle2</DBInstanceArn>
    <DBInstanceIdentifier>myoracle1</DBInstanceIdentifier>
    <RestoreWindow>
      <EarliestTime>2018-08-21T00:33:32.648Z</EarliestTime>
      <LatestTime>2018-08-28T20:16:27Z</LatestTime>
    </RestoreWindow>
    <Encrypted>false</Encrypted>
    <Engine>oracle-ee</Engine>
    <Port>1521</Port>
    <LicenseModel>bring-your-own-license</LicenseModel>
    <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
    <StorageType>magnetic</StorageType>
    <OptionGroupName>default:oracle-ee-11-2</OptionGroupName>
    <Region>us-east-1</Region>
    <Status>active</Status>
  </DBInstanceAutomatedBackup>
</DBInstanceAutomatedBackups>
</DescribeDBInstanceAutomatedBackupsResult>
<ResponseMetadata>
<RequestId>298f362b-e14a-4ee0-9840-4546c276014a</RequestId>
</ResponseMetadata>
</DescribeDBInstanceAutomatedBackupsResponse>
```

## See Also
<a name="API_DescribeDBInstanceAutomatedBackups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBInstanceAutomatedBackups) 

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

Describes provisioned RDS instances. This API supports pagination.

**Note**  
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

## Request Parameters
<a name="API_DescribeDBInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match the identifier of an existing DB instance.
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB instances to describe.  
Supported Filters:  
+  `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.
+  `db-instance-id` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.
+  `dbi-resource-id` - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
+  `domain` - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
+  `engine` - Accepts engine names. The results list only includes information about the DB instances for these engines.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBInstances` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBInstances_ResponseElements"></a>

The following elements are returned by the service.

 **DBInstances.DBInstance.N**   
A list of `DBInstance` instances.  
Type: Array of [DBInstance](API_DBInstance.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` .  
Type: String

## Errors
<a name="API_DescribeDBInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBInstances_Examples"></a>

### Example
<a name="API_DescribeDBInstances_Example_1"></a>

This example illustrates one usage of DescribeDBInstances.

#### Sample Request
<a name="API_DescribeDBInstances_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeDBInstances
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-east-1/rds/aws4_request
   &X-Amz-Date=20140420T171917Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=caa44629fa60576c2c282d9b74d47647f9e9f229f6d0e52db1d3be0d095743b0
```

#### Sample Response
<a name="API_DescribeDBInstances_Example_1_Response"></a>

```
<DescribeDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBInstancesResult>
    <DBInstances>
      <DBInstance>
        <AllocatedStorage>100</AllocatedStorage>
        <DBParameterGroups>
          <DBParameterGroup>
            <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          </DBParameterGroup>
        </DBParameterGroups>
        <AvailabilityZone>us-east-1b</AvailabilityZone>
        <SecondaryAvailabilityZone>us-east-1a</SecondaryAvailabilityZone>
        <DBSecurityGroups/>
        <Iops>1000</Iops>
        <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-IXRXA2XS7KFFA6JWYYWFZEBJDE</EnhancedMonitoringResourceArn>
        <EngineVersion>5.6.39</EngineVersion>
        <MasterUsername>mysqldbadmin</MasterUsername>
        <InstanceCreateTime>2018-03-28T19:54:07.871Z</InstanceCreateTime>
        <DBInstanceClass>db.m4.xlarge</DBInstanceClass>
        <ReadReplicaDBInstanceIdentifiers/>
        <MonitoringInterval>60</MonitoringInterval>
        <DBInstanceStatus>available</DBInstanceStatus>
        <BackupRetentionPeriod>7</BackupRetentionPeriod>
        <KmsKeyId>arn:aws:kms:us-east-1:1234567890:key/######################</KmsKeyId>
        <OptionGroupMemberships>
          <OptionGroupMembership>
            <OptionGroupName>default:mysql-5-6</OptionGroupName>
            <Status>in-sync</Status>
          </OptionGroupMembership>
        </OptionGroupMemberships>
        <LatestRestorableTime>2018-03-28T20:10:00Z</LatestRestorableTime>
        <CACertificateIdentifier>rds-ca-2015</CACertificateIdentifier>
        <DbInstancePort>0</DbInstancePort>
        <DbiResourceId>db-IXRXA2XS7KFFA6JWYYWFZEBJDE</DbiResourceId>
        <PreferredBackupWindow>05:27-05:57</PreferredBackupWindow>
        <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
        <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:mysqldb</DBInstanceArn>
        <Endpoint>
          <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
          <Address>mysqldb.########.us-east-1.rds.amazonaws.com</Address>
          <Port>3306</Port>
        </Endpoint>
        <Engine>mysql</Engine>
        <PubliclyAccessible>true</PubliclyAccessible>
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
        <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
        <MultiAZ>true</MultiAZ>
        <MonitoringRoleArn>arn:aws:iam::1234567890:role/rds-monitoring-role</MonitoringRoleArn>
        <DomainMemberships/>
        <StorageEncrypted>true</StorageEncrypted>
        <DBSubnetGroup>
          <VpcId>vpc-########</VpcId>
          <Subnets>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1e</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1d</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1c</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1f</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1a</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1b</Name>
              </SubnetAvailabilityZone>
            </Subnet>
          </Subnets>
          <SubnetGroupStatus>Complete</SubnetGroupStatus>
          <DBSubnetGroupDescription>default</DBSubnetGroupDescription>
          <DBSubnetGroupName>default</DBSubnetGroupName>
        </DBSubnetGroup>
        <VpcSecurityGroups>
          <VpcSecurityGroupMembership>
            <VpcSecurityGroupId>sg-########</VpcSecurityGroupId>
            <Status>active</Status>
          </VpcSecurityGroupMembership>
        </VpcSecurityGroups>
        <LicenseModel>general-public-license</LicenseModel>
        <PendingModifiedValues/>
        <PreferredMaintenanceWindow>fri:05:57-fri:06:27</PreferredMaintenanceWindow>
        <StorageType>io1</StorageType>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      </DBInstance>
      <DBInstance>
        <AllocatedStorage>100</AllocatedStorage>
        <DBParameterGroups>
          <DBParameterGroup>
            <DBParameterGroupName>default.oracle-ee-12.1</DBParameterGroupName>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          </DBParameterGroup>
        </DBParameterGroups>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <SecondaryAvailabilityZone>us-east-1f</SecondaryAvailabilityZone>
        <DBSecurityGroups/>
        <Iops>1000</Iops>
        <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-YVS5NRBNHPGJZ3IT3WADXYSWYU</EnhancedMonitoringResourceArn>
        <EngineVersion>12.1.0.2.v11</EngineVersion>
        <MasterUsername>oracledbadmin</MasterUsername>
        <InstanceCreateTime>2018-03-28T20:00:48.832Z</InstanceCreateTime>
        <DBInstanceClass>db.m4.xlarge</DBInstanceClass>
        <ReadReplicaDBInstanceIdentifiers/>
        <MonitoringInterval>60</MonitoringInterval>
        <DBInstanceStatus>available</DBInstanceStatus>
        <BackupRetentionPeriod>7</BackupRetentionPeriod>
        <KmsKeyId>arn:aws:kms:us-east-1:1234567890:key/###################</KmsKeyId>
        <OptionGroupMemberships>
          <OptionGroupMembership>
            <OptionGroupName>default:oracle-ee-12-1</OptionGroupName>
            <Status>in-sync</Status>
          </OptionGroupMembership>
        </OptionGroupMemberships>
        <LatestRestorableTime>2018-03-28T20:14:30.818Z</LatestRestorableTime>
        <CACertificateIdentifier>rds-ca-2015</CACertificateIdentifier>
        <DbInstancePort>0</DbInstancePort>
        <DbiResourceId>db-YVS5NRBNHPGJZ3IT3WADXYSWYU</DbiResourceId>
        <PreferredBackupWindow>07:39-08:09</PreferredBackupWindow>
        <DBInstanceIdentifier>oracledb</DBInstanceIdentifier>
        <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:oracledb</DBInstanceArn>
        <Endpoint>
          <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
          <Address>oracledb.########.us-east-1.rds.amazonaws.com</Address>
          <Port>1521</Port>
        </Endpoint>
        <Engine>oracle-ee</Engine>
        <PubliclyAccessible>true</PubliclyAccessible>
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
        <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
        <DBName>ORCL</DBName>
        <MultiAZ>true</MultiAZ>
        <CharacterSetName>AL32UTF8</CharacterSetName>
        <MonitoringRoleArn>arn:aws:iam::1234567890:role/rds-monitoring-role</MonitoringRoleArn>
        <DomainMemberships/>
        <StorageEncrypted>true</StorageEncrypted>
        <DBSubnetGroup>
          <VpcId>vpc-########</VpcId>
          <Subnets>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1e</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1d</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1c</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1f</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1a</Name>
              </SubnetAvailabilityZone>
            </Subnet>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1b</Name>
              </SubnetAvailabilityZone>
            </Subnet>
          </Subnets>
          <SubnetGroupStatus>Complete</SubnetGroupStatus>
          <DBSubnetGroupDescription>default</DBSubnetGroupDescription>
          <DBSubnetGroupName>default</DBSubnetGroupName>
        </DBSubnetGroup>
        <VpcSecurityGroups>
          <VpcSecurityGroupMembership>
            <VpcSecurityGroupId>sg-########</VpcSecurityGroupId>
            <Status>active</Status>
          </VpcSecurityGroupMembership>
        </VpcSecurityGroups>
        <LicenseModel>bring-your-own-license</LicenseModel>
        <PendingModifiedValues/>
        <PreferredMaintenanceWindow>tue:08:39-tue:09:09</PreferredMaintenanceWindow>
        <StorageType>io1</StorageType>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      </DBInstance>
    </DBInstances>
  </DescribeDBInstancesResult>
  <ResponseMetadata>
    <RequestId>298f362b-e14a-4ee0-9840-4546c276014a</RequestId>
  </ResponseMetadata>
</DescribeDBInstancesResponse>
```

## See Also
<a name="API_DescribeDBInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBInstances) 

# DescribeDBLogFiles
<a name="API_DescribeDBLogFiles"></a>

Returns a list of DB log files for the DB instance.

This command doesn't apply to RDS Custom.

## Request Parameters
<a name="API_DescribeDBLogFiles_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The customer-assigned name of the DB instance that contains the log files you want to list.  
Constraints:  
+ Must match the identifier of an existing DBInstance.
Type: String  
Required: Yes

 ** FileLastWritten **   
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.  
Type: Long  
Required: No

 ** FilenameContains **   
Filters the available log files for log file names that contain the specified string.  
Type: String  
Required: No

 ** FileSize **   
Filters the available log files for files larger than the specified size.  
Type: Long  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBLogFiles_ResponseElements"></a>

The following elements are returned by the service.

 **DescribeDBLogFiles.DescribeDBLogFilesDetails.N**   
The DB log files returned.  
Type: Array of [DescribeDBLogFilesDetails](API_DescribeDBLogFilesDetails.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeDBLogFiles` request.  
Type: String

## Errors
<a name="API_DescribeDBLogFiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBInstanceNotReady **   
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeDBLogFiles_Examples"></a>

### Example
<a name="API_DescribeDBLogFiles_Example_1"></a>

This example illustrates one usage of DescribeDBLogFiles.

#### Sample Request
<a name="API_DescribeDBLogFiles_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeDBLogFiles
   &DBInstanceIdentifier=mysqldb
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4 
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-east-1/rds/aws4_request
   &X-Amz-Date=20140421T225750Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9020fd1bcd658614e058cd2eb8c58572cf6c11460b1e96380635ee428a52e8a1
```

#### Sample Response
<a name="API_DescribeDBLogFiles_Example_1_Response"></a>

```
<DescribeDBLogFilesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBLogFilesResult>
    <DescribeDBLogFiles>
      <DescribeDBLogFilesDetails>
        <LastWritten>1398119101000</LastWritten>
        <LogFileName>error/mysql-error-running.log</LogFileName>
        <Size>1599</Size>
      </DescribeDBLogFilesDetails>
      <DescribeDBLogFilesDetails>
        <LastWritten>1398120900000</LastWritten>
        <LogFileName>error/mysql-error.log</LogFileName>
        <Size>0</Size>
      </DescribeDBLogFilesDetails>
    </DescribeDBLogFiles>
  </DescribeDBLogFilesResult>
  <ResponseMetadata>
    <RequestId>4c6ed648-b9f7-11d3-97bd-7999dd5a8f72</RequestId>
  </ResponseMetadata>
</DescribeDBLogFilesResponse>
```

## See Also
<a name="API_DescribeDBLogFiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBLogFiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBLogFiles) 

# DescribeDBMajorEngineVersions
<a name="API_DescribeDBMajorEngineVersions"></a>

Describes the properties of specific major versions of DB engines.

## Request Parameters
<a name="API_DescribeDBMajorEngineVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The database engine to return major version details for.  
Valid Values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `custom-sqlserver-ee` 
+  `custom-sqlserver-se` 
+  `custom-sqlserver-web` 
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** MajorEngineVersion **   
A specific database major engine version to return details for.  
Example: `8.4`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 340.  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

## Response Elements
<a name="API_DescribeDBMajorEngineVersions_ResponseElements"></a>

The following elements are returned by the service.

 **DBMajorEngineVersions.DBMajorEngineVersion.N**   
A list of `DBMajorEngineVersion` elements.  
Type: Array of [DBMajorEngineVersion](API_DBMajorEngineVersion.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBMajorEngineVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeDBMajorEngineVersions_Examples"></a>

### Example
<a name="API_DescribeDBMajorEngineVersions_Example_1"></a>

This example illustrates one usage of DescribeDBMajorEngineVersions.

#### Sample Request
<a name="API_DescribeDBMajorEngineVersions_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBMajorEngineVersions
   &MaxRecords=100 
   &SignatureMethod=HmacSHA256 
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4772d17a4c43bcd209ff42a0778dd23e73f8434253effd7ac53b89ade3dad45f
```

#### Sample Response
<a name="API_DescribeDBMajorEngineVersions_Example_1_Response"></a>

```
<DescribeDBMajorEngineVersionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBMajorEngineVersionsResult>
    <DBMajorEngineVersions>
      <DBMajorEngineVersion>
        <Engine>mysql</Engine>
        <MajorEngineVersion>8.0</MajorEngineVersion>
      </DBMajorEngineVersion>
      <DBMajorEngineVersion>
        <Engine>mysql</Engine>
        <MajorEngineVersion>8.0</MajorEngineVersion>
        <SupportedEngineLifecycles>
          <LifecycleSupportName>open-source-rds-standard-support</LifecycleSupportName>
          <LifecycleSupportStartDate>2021-08-26T00:00:00+00:00</LifecycleSupportStartDate>
          <LifecycleSupportEndDate>2026-02-28T23:59:59.999000+00:00</LifecycleSupportEndDate>
        </SupportedEngineLifecycles>
      </DBMajorEngineVersion>
  </DescribeDBMajorEngineVersionsResult>
  <ResponseMetadata>
    <RequestId>b74d2635-b98c-11d3-fbc7-5c0aad74da7c</RequestId>
  </ResponseMetadata>
</DescribeDBMajorEngineVersionsResponse>
```

## See Also
<a name="API_DescribeDBMajorEngineVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBMajorEngineVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBMajorEngineVersions) 

# DescribeDBParameterGroups
<a name="API_DescribeDBParameterGroups"></a>

Returns a list of `DBParameterGroup` descriptions. If a `DBParameterGroupName` is specified, the list will contain only the description of the specified DB parameter group.

## Request Parameters
<a name="API_DescribeDBParameterGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupName **   
The name of a specific DB parameter group to return details for.  
Constraints:  
+ If supplied, must match the name of an existing DBClusterParameterGroup.
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBParameterGroups_ResponseElements"></a>

The following elements are returned by the service.

 **DBParameterGroups.DBParameterGroup.N**   
A list of `DBParameterGroup` instances.  
Type: Array of [DBParameterGroup](API_DBParameterGroup.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBParameterGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBParameterGroups_Examples"></a>

### Example
<a name="API_DescribeDBParameterGroups_Example_1"></a>

This example illustrates one usage of DescribeDBParameterGroups.

#### Sample Request
<a name="API_DescribeDBParameterGroups_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBParameterGroups
   &DBParameterGroupName=mysql-logs
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e2753df1cb019f212057b51e8a2ac16dae05b344063355b195b560ef6e76661a
```

#### Sample Response
<a name="API_DescribeDBParameterGroups_Example_1_Response"></a>

```
<DescribeDBParameterGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBParameterGroupsResult>
    <DBParameterGroups>
      <DBParameterGroup>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <Description>Default parameter group for mysql5.1</Description>
        <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>
      </DBParameterGroup>
      <DBParameterGroup>
        <DBParameterGroupFamily>mysql5.5</DBParameterGroupFamily>
        <Description>Default parameter group for mysql5.5</Description>
        <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
      </DBParameterGroup>
      <DBParameterGroup>
        <DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily>
        <Description>Default parameter group for mysql5.6</Description>
        <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
      </DBParameterGroup>
    </DBParameterGroups>
  </DescribeDBParameterGroupsResult>
  <ResponseMetadata>
    <RequestId>b75d527a-b98c-11d3-f272-7cd6cce12cc5</RequestId>
  </ResponseMetadata>
</DescribeDBParameterGroupsResponse>
```

## See Also
<a name="API_DescribeDBParameterGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameterGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBParameterGroups) 

# DescribeDBParameters
<a name="API_DescribeDBParameters"></a>

Returns the detailed parameter list for a particular DB parameter group.

## Request Parameters
<a name="API_DescribeDBParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupName **   
The name of a specific DB parameter group to return details for.  
Constraints:  
+ If supplied, must match the name of an existing DBParameterGroup.
Type: String  
Required: Yes

 **Filters.Filter.N**   
A filter that specifies one or more DB parameters to describe.  
The only supported filter is `parameter-name`. The results list only includes information about the DB parameters with these names.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** Source **   
The parameter types to return.  
Default: All parameter types returned  
Valid Values: `user | system | engine-default`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeDBParameters_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **Parameters.Parameter.N**   
A list of `Parameter` values.  
Type: Array of [Parameter](API_Parameter.md) objects

## Errors
<a name="API_DescribeDBParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBParameters_Examples"></a>

### Example
<a name="API_DescribeDBParameters_Example_1"></a>

This example illustrates one usage of DescribeDBParameters.

#### Sample Request
<a name="API_DescribeDBParameters_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeDBParameters
   &DBParameterGroupName=oracle-logs
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-east-1/rds/aws4_request
   &X-Amz-Date=20140421T231357Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=ac9b18d6ae7cab4bf45ed2caa99cd8438101b293c0a84e80c3bab77f7369cc7
```

#### Sample Response
<a name="API_DescribeDBParameters_Example_1_Response"></a>

```
<DescribeDBParametersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBParametersResult>
    <Marker>bGlzdGVuZXJfbmV0d29ya3M=</Marker>
    <Parameters>
      <Parameter>
        <DataType>integer</DataType>
        <Source>engine-default</Source>
        <IsModifiable>true</IsModifiable>
        <Description>number of AQ Time Managers to start</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>0-40</AllowedValues>
        <ParameterName>aq_tm_processes</ParameterName>
      </Parameter>
      <Parameter>
        <ParameterValue>300</ParameterValue>
        <DataType>integer</DataType>
        <Source>system</Source>
        <IsModifiable>false</IsModifiable>
        <Description>Maximum number of seconds of redos the standby could lose</Description>
        <ApplyType>dynamic</ApplyType>
        <ParameterName>archive_lag_target</ParameterName>
      </Parameter>
      <Parameter>
        <ParameterValue>/rdsdbdata/admin/{dbName}/adump</ParameterValue>
        <DataType>string</DataType>
        <Source>system</Source>
        <IsModifiable>false</IsModifiable>
        <Description>Directory in which auditing files are to reside</Description>
        <ApplyType>dynamic</ApplyType>
        <ParameterName>audit_file_dest</ParameterName>
      </Parameter>
      <Parameter>
        <DataType>boolean</DataType>
        <Source>engine-default</Source>
        <IsModifiable>false</IsModifiable>
        <Description>enable sys auditing</Description>
        <ApplyType>static</ApplyType>
        <AllowedValues>TRUE,FALSE</AllowedValues>
        <ParameterName>audit_sys_operations</ParameterName>
      </Parameter>
      <Parameter>
        <DataType>string</DataType>
        <Source>engine-default</Source>
        <IsModifiable>false</IsModifiable>
        <Description>Syslog facility and level</Description>
        <ApplyType>static</ApplyType>
        <ParameterName>audit_syslog_level</ParameterName>
      </Parameter>
      <Parameter>
        <DataType>string</DataType>
        <Source>engine-default</Source>
        <IsModifiable>true</IsModifiable>
        <Description>enable system auditing</Description>
        <ApplyType>static</ApplyType>
        <AllowedValues>DB,OS,NONE,TRUE,FALSE,DB_EXTENDED,XML</AllowedValues>
        <ParameterName>audit_trail</ParameterName>
      </Parameter>
    </Parameters>
  </DescribeDBParametersResult>
  <ResponseMetadata>
    <RequestId>8c40488f-b9ff-11d3-a15e-7ac49293f4fa</RequestId>
  </ResponseMetadata>
</DescribeDBParametersResponse>
```

## See Also
<a name="API_DescribeDBParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBParameters) 

# DescribeDBProxies
<a name="API_DescribeDBProxies"></a>

Returns information about DB proxies.

## Request Parameters
<a name="API_DescribeDBProxies_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your AWS account ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 **Filters.Filter.N**   
This parameter is not currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

## Response Elements
<a name="API_DescribeDBProxies_ResponseElements"></a>

The following elements are returned by the service.

 **DBProxies.member.N**   
A return value representing an arbitrary number of `DBProxy` data structures.  
Type: Array of [DBProxy](API_DBProxy.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBProxies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBProxies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBProxies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBProxies) 

# DescribeDBProxyEndpoints
<a name="API_DescribeDBProxyEndpoints"></a>

Returns information about DB proxy endpoints.

## Request Parameters
<a name="API_DescribeDBProxyEndpoints_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyEndpointName **   
The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 ** DBProxyName **   
The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 **Filters.Filter.N**   
This parameter is not currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

## Response Elements
<a name="API_DescribeDBProxyEndpoints_ResponseElements"></a>

The following elements are returned by the service.

 **DBProxyEndpoints.member.N**   
The list of `ProxyEndpoint` objects returned by the API operation.  
Type: Array of [DBProxyEndpoint](API_DBProxyEndpoint.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBProxyEndpoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBProxyEndpoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBProxyEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBProxyEndpoints) 

# DescribeDBProxyTargetGroups
<a name="API_DescribeDBProxyTargetGroups"></a>

Returns information about DB proxy target groups, represented by `DBProxyTargetGroup` data structures.

## Request Parameters
<a name="API_DescribeDBProxyTargetGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier of the `DBProxy` associated with the target group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **Filters.Filter.N**   
This parameter is not currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

 ** TargetGroupName **   
The identifier of the `DBProxyTargetGroup` to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

## Response Elements
<a name="API_DescribeDBProxyTargetGroups_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **TargetGroups.member.N**   
An arbitrary number of `DBProxyTargetGroup` objects, containing details of the corresponding target groups.  
Type: Array of [DBProxyTargetGroup](API_DBProxyTargetGroup.md) objects

## Errors
<a name="API_DescribeDBProxyTargetGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeDBProxyTargetGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBProxyTargetGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBProxyTargetGroups) 

# DescribeDBProxyTargets
<a name="API_DescribeDBProxyTargets"></a>

Returns information about `DBProxyTarget` objects. This API supports pagination.

## Request Parameters
<a name="API_DescribeDBProxyTargets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier of the `DBProxyTarget` to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **Filters.Filter.N**   
This parameter is not currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

 ** TargetGroupName **   
The identifier of the `DBProxyTargetGroup` to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

## Response Elements
<a name="API_DescribeDBProxyTargets_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **Targets.member.N**   
An arbitrary number of `DBProxyTarget` objects, containing details of the corresponding targets.  
Type: Array of [DBProxyTarget](API_DBProxyTarget.md) objects

## Errors
<a name="API_DescribeDBProxyTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetNotFoundFault **   
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeDBProxyTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBProxyTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBProxyTargets) 

# DescribeDBRecommendations
<a name="API_DescribeDBRecommendations"></a>

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

## Request Parameters
<a name="API_DescribeDBRecommendations_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
A filter that specifies one or more recommendations to describe.  
Supported Filters:  
+  `recommendation-id` - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.
+  `status` - Accepts a list of recommendation statuses.

  Valid values:
  +  `active` - The recommendations which are ready for you to apply.
  +  `pending` - The applied or scheduled recommendations which are in progress.
  +  `resolved` - The recommendations which are completed.
  +  `dismissed` - The recommendations that you dismissed.

  The results list only includes the recommendations whose status is one of the specified filter values.
+  `severity` - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.

  Valid values:
  +  `high` 
  +  `medium` 
  +  `low` 
  +  `informational` 
+  `type-id` - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.
+  `dbi-resource-id` - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.
+  `cluster-resource-id` - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.
+  `pg-arn` - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.
+  `cluster-pg-arn` - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** LastUpdatedAfter **   
A filter to include only the recommendations that were updated after this specified time.  
Type: Timestamp  
Required: No

 ** LastUpdatedBefore **   
A filter to include only the recommendations that were updated before this specified time.  
Type: Timestamp  
Required: No

 ** Locale **   
The language that you choose to return the list of recommendations.  
Valid values:  
+  `en` 
+  `en_UK` 
+  `de` 
+  `es` 
+  `fr` 
+  `id` 
+  `it` 
+  `ja` 
+  `ko` 
+  `pt_BR` 
+  `zh_TW` 
+  `zh_CN` 
Type: String  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBRecommendations` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.   
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of recommendations to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBRecommendations_ResponseElements"></a>

The following elements are returned by the service.

 **DBRecommendations.member.N**   
A list of recommendations which is returned from `DescribeDBRecommendations` API request.  
Type: Array of [DBRecommendation](API_DBRecommendation.md) objects

 ** Marker **   
An optional pagination token provided by a previous `DBRecommendationsMessage` request. This token can be used later in a `DescribeDBRecomendations` request.   
Type: String

## Errors
<a name="API_DescribeDBRecommendations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeDBRecommendations_Examples"></a>

### Describing all the recommendations in the account
<a name="API_DescribeDBRecommendations_Example_1"></a>

This example illustrates one usage of DescribeDBRecommendations.

#### Sample Request
<a name="API_DescribeDBRecommendations_Example_1_Request"></a>

```
  https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeDBRecommendations
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230222/us-east-1/rds/aws4_request
    &X-Amz-Date=20230222T200807Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_DescribeDBRecommendations_Example_1_Response"></a>

```
  <DescribeDBRecommendationsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBRecommendationsResult>
    <DBRecommendations>
      <member>
        <RecommendationId>15e811d7-ec23-4d94-8d28-74cd2e7729ad</RecommendationId>
        <TypeId>config_recommendation::multi_az_instance</TypeId>
        <Severity>low</Severity>
        <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
        <Status>active</Status>
        <CreatedTime>2023-10-05T18:04:04.017000+00:00</CreatedTime>
        <UpdatedTime>2023-10-20T18:35:46+00:00</UpdatedTime>
        <Detection>**1 resource** is not a Multi-AZ instance</Detection>
        <Recommendation>Set up Multi-AZ for the impacted DB instances</Recommendation>
        <Description>We recommend that you use Multi-AZ deployment. The Multi-AZ deployments enhance the availability and durability of the DB instance. Click Info for more details about Multi-AZ deployment and pricing.</Description>
        <RecommendedActions>
          <member>
            <ActionId>806effbdc8853c4bf0e794c0c240ee8e</ActionId>
            <Operation>modifyDbInstance</Operation>
            <Parameters>
              <member>
                <Key>MultiAZ</Key>
                <Value>true</Value>
              </member>
              <member>
                <Key>DBInstanceIdentifier</Key>
                <Value>mariadb-instance</Value>
              </member>
            </Parameters>
            <ApplyModes>
              <member>immediately</member>
              <member>next-maintenance-window</member>
            </ApplyModes>
            <Status>ready</Status>
            <ContextAttributes>
              <member>
                <Key>resourceArn</Key>
                <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
              </member>
            </ContextAttributes>
            <ContextAttributes>
              <member>
                <Key>engineName</Key>
                <Value>mariadb</Value>
              </member>
            </ContextAttributes>
          </member>
        </RecommendedActions>
        <Category>reliability</Category>
        <Source>RDS</Source>
        <TypeDetection>**[resource-count] resources** are not Multi-AZ instances</TypeDetection>
        <TypeRecommendation>Set up Multi-AZ for the impacted DB instances</TypeRecommendation>
        <Impact>Data availability at risk</Impact>
        <AdditionalInfo>In an Amazon RDS Multi-AZ deployment, Amazon RDS automatically creates a primary database instance and replicates the data to an instance in a different availability zone. When it detects a failure, Amazon RDS automatically fails over to a standby instance without manual intervention.</AdditionalInfo>
        <Links>
          <member>
            <Text>Pricing for Amazon RDS Multi-AZ</Text>
            <Url>https://aws.amazon.com/rds/features/multi-az/#Pricing</Url>
          </member>
        </Links>
      </member>
      <member>
        <RecommendationId>8c9132b0-267d-4493-b3c4-aedd0920809d</RecommendationId>
        <TypeId>config_recommendation::enhanced_monitoring_off</TypeId>
        <Severity>low</Severity>
        <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
        <Status>active</Status>
        <CreatedTime>2023-10-05T18:04:03.957000+00:00</CreatedTime>
        <UpdatedTime>2023-10-20T18:35:46+00:00</UpdatedTime>
        <Detection>**1 resource** doesn't have Enhanced Monitoring enabled</Detection>
        <Recommendation>Turn on Enhanced Monitoring</Recommendation>
        <Description>Your database resources don't have Enhanced Monitoring turned on. Enhanced Monitoring provides real-time operating system metrics for monitoring and troubleshooting.</Description>
        <RecommendedActions>
          <member>
            <ActionId>a2e5e55f28854f9ec12f45c227d85f48</ActionId>
            <Operation>modifyDbInstance</Operation>
            <Parameters>
              <member>
                <Key>MonitoringInterval</Key>
                <Value>60</Value>
              </member>
              <member>
                <Key>DBInstanceIdentifier</Key>
                <Value>mariadb-instance</Value>
              </member>
            </Parameters>
            <ApplyModes>
              <member>immediately</member>
            </ApplyModes>
            <Status>ready</Status>
            <ContextAttributes>
              <member>
                <Key>resourceArn</Key>
                <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
              </member>
              <member>
                <Key>engineName</Key>
                <Value>mariadb</Value>
              </member>
              <member>
                <Key>recommendedValue</Key>
                <Value>60</Value>
              </member>
            </ContextAttributes>
          </member>
        </RecommendedActions>
        <Category>reliability</Category>
        <Source>RDS</Source>
        <TypeDetection>**[resource-count] resources** don't have Enhanced Monitoring enabled</TypeDetection>
        <TypeRecommendation>Turn on Enhanced Monitoring</TypeRecommendation>
        <Impact>Reduced operational visibility</Impact>
        <AdditionalInfo>Enhanced Monitoring for Amazon RDS provides additional visibility on the health of your DB instances. We recommend that you turn on Enhanced Monitoring. When the Enhanced Monitoring option is turned on for your DB instance, it collects vital operating system metrics and process information.</AdditionalInfo>
        <Links>
          <member>
            <Text>Turning Enhanced Monitoring on and off</Text>
            <Url>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html</Url>
          </member>
        </Links>
      </member>
      <member>
        <RecommendationId>bdbda802-2472-406f-a7bc-e17ee5836a76</RecommendationId>
        <TypeId>performance_recommendation::temp_tables_on_disk</TypeId>
        <Severity>high</Severity>
        <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mysql-instance</ResourceArn>
        <Status>active</Status>
        <CreatedTime>2023-10-05T17:11:07.307000+00:00</CreatedTime>
        <UpdatedTime>2023-10-13T18:40:33+00:00</UpdatedTime>
        <Detection>Instance [resource-name] is creating temporary tables on disk</Detection>
        <Recommendation>Review memory parameters and tune queries</Recommendation>
        <Description>Based on your usage, we recommend the following:  \n  \n* Review memory parameters and tune queries. For example:\n\t* Use the TempTable storage engine in MySQL 8.0.\n\t* Tune the database parameters tmp_table_size and max_heap_table_size.\n\t* Select only necessary columns and avoid using BLOB and TEXT columns.\n\t* Index columns involved in sorting and grouping.\n\t* Reduce the data returned by your queries. Investigate them by querying sys.statements_with_temp_table.\n* [View troubleshooting doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/proactive-insights.temp-tables.html)  \n  \n@> Why do we recommend this?  \nWhen temporary data can't fit in memory, the database uses on-disk temporary tables. These tables can decrease performance, increase the duration of scheduled upgrades, and increase the IOPS rate.  \n  \nWithin 15 minutes, the database created more than 2 temporary tables per second and more than 50% of all temporary tables used disk.  \n@></Description>
        <RecommendedActions/>
        <Category>performance</Category>
        <Source>RDS</Source>
        <Impact>Database performance degradation</Impact>
        <IssueDetails>
          <PerformanceIssueDetails>
            <StartTime>2023-09-11T19:00:21+00:00</StartTime>
            <Metrics>
              <member>
                <Name>Temporary Tables On Disk</Name>
                <References>
                  <member>
                    <Name>Temp Tables on Disk Rate</Name>
                    <ReferenceDetails>
                      <ScalarReferenceDetails>
                        <Value>2</Value>
                      </ScalarReferenceDetails>
                    </ReferenceDetails>
                  </member>
                </References>
                <StatisticsDetails>==Peak value: 3==  \nMedium severity threshold: 2  \nHigh severity threshold: -</StatisticsDetails>
                <MetricQuery>
                  <PerformanceInsightsMetricQuery>
                    <Metric>db.Temp.Created_tmp_disk_tables.avg</Metric>
                  </PerformanceInsightsMetricQuery>
                </MetricQuery>
              </member>
              <member>
                <Name>Percentage of the temporary tables created that use disk</Name>
                <References>
                  <member>
                    <Name>Temp Tables on Disk Percent</Name>
                    <ReferenceDetails>
                      <ScalarReferenceDetails>
                        <Value>50</Value>
                      </ScalarReferenceDetails>
                    </ReferenceDetails>
                  </member>
                </References>
                <StatisticsDetails>==Peak value: 59==  \nMedium severity threshold: 50  \nHigh severity threshold: -</StatisticsDetails>
                <MetricQuery>
                  <PerformanceInsightsMetricQuery>
                    <Metric>db.Temp.temp_disk_tables_percent.avg</Metric>
                  </PerformanceInsightsMetricQuery>
                </MetricQuery>
              </member>
              <member>
                <Name>Total Created Temporary Tables</Name>
                <StatisticsDetails>==Peak value: -==  \nMedium severity threshold: -  \nHigh severity threshold: -</StatisticsDetails>
                <MetricQuery>
                  <PerformanceInsightsMetricQuery>
                    <Metric>db.Temp.Created_tmp_tables.max</Metric>
                  </PerformanceInsightsMetricQuery>
                </MetricQuery>
              </member>
            </Metrics>
            <Analysis>Starting on 09/11/2023 19:00:21, your recent on-disk temporary table usage increased significantly, up to 58.82 percent. The database is creating up to 3 temporary tables per second on disk, which might impact performance. This insight appears because both the percentage of temporary tables on disk and the rate of temporary tables on disk created per second exceeded their thresholds.</Analysis>
          </PerformanceIssueDetails>
        </IssueDetails>
      </member>
    </DBRecommendations>
  </DescribeDBRecommendationsResult>
</DescribeDBRecommendationsResponse>
```

### Filtering the recommendations by last updated time
<a name="API_DescribeDBRecommendations_Example_2"></a>

This example illustrates one usage of DescribeDBRecommendations.

#### Sample Request
<a name="API_DescribeDBRecommendations_Example_2_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeDBRecommendations
    &LastUpdatedBefore=2023-10-21
    &LastUpdatedAfter=2023-10-19
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230222/us-east-1/rds/aws4_request
    &X-Amz-Date=20230222T200807Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_DescribeDBRecommendations_Example_2_Response"></a>

```
<DescribeDBRecommendationsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBRecommendationsResult>
    <DBRecommendations>
      <member>
        <RecommendationId>15e811d7-ec23-4d94-8d28-74cd2e7729ad</RecommendationId>
        <TypeId>config_recommendation::multi_az_instance</TypeId>
        <Severity>low</Severity>
        <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
        <Status>active</Status>
        <CreatedTime>2023-10-05T18:04:04.017000+00:00</CreatedTime>
        <UpdatedTime>2023-10-20T18:35:46+00:00</UpdatedTime>
        <Detection>**1 resource** is not a Multi-AZ instance</Detection>
        <Recommendation>Set up Multi-AZ for the impacted DB instances</Recommendation>
        <Description>We recommend that you use Multi-AZ deployment. The Multi-AZ deployments enhance the availability and durability of the DB instance. Click Info for more details about Multi-AZ deployment and pricing.</Description>
        <RecommendedActions>
          <member>
            <ActionId>806effbdc8853c4bf0e794c0c240ee8e</ActionId>
            <Operation>modifyDbInstance</Operation>
            <Parameters>
              <member>
                <Key>MultiAZ</Key>
                <Value>true</Value>
              </member>
              <member>
                <Key>DBInstanceIdentifier</Key>
                <Value>mariadb-instance</Value>
              </member>
            </Parameters>
            <ApplyModes>
              <member>immediately</member>
              <member>next-maintenance-window</member>
            </ApplyModes>
            <Status>ready</Status>
            <ContextAttributes>
              <member>
                <Key>resourceArn</Key>
                <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
              </member>
            </ContextAttributes>
            <ContextAttributes>
              <member>
                <Key>engineName</Key>
                <Value>mariadb</Value>
              </member>
            </ContextAttributes>
          </member>
        </RecommendedActions>
        <Category>reliability</Category>
        <Source>RDS</Source>
        <TypeDetection>**[resource-count] resources** are not Multi-AZ instances</TypeDetection>
        <TypeRecommendation>Set up Multi-AZ for the impacted DB instances</TypeRecommendation>
        <Impact>Data availability at risk</Impact>
        <AdditionalInfo>In an Amazon RDS Multi-AZ deployment, Amazon RDS automatically creates a primary database instance and replicates the data to an instance in a different availability zone. When it detects a failure, Amazon RDS automatically fails over to a standby instance without manual intervention.</AdditionalInfo>
        <Links>
          <member>
            <Text>Pricing for Amazon RDS Multi-AZ</Text>
            <Url>https://aws.amazon.com/rds/features/multi-az/#Pricing</Url>
          </member>
        </Links>
      </member>
      <member>
        <RecommendationId>8c9132b0-267d-4493-b3c4-aedd0920809d</RecommendationId>
        <TypeId>config_recommendation::enhanced_monitoring_off</TypeId>
        <Severity>low</Severity>
        <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
        <Status>active</Status>
        <CreatedTime>2023-10-05T18:04:03.957000+00:00</CreatedTime>
        <UpdatedTime>2023-10-20T18:35:46+00:00</UpdatedTime>
        <Detection>**1 resource** doesn't have Enhanced Monitoring enabled</Detection>
        <Recommendation>Turn on Enhanced Monitoring</Recommendation>
        <Description>Your database resources don't have Enhanced Monitoring turned on. Enhanced Monitoring provides real-time operating system metrics for monitoring and troubleshooting.</Description>
        <RecommendedActions>
          <member>
            <ActionId>a2e5e55f28854f9ec12f45c227d85f48</ActionId>
            <Operation>modifyDbInstance</Operation>
            <Parameters>
              <member>
                <Key>MonitoringInterval</Key>
                <Value>60</Value>
              </member>
              <member>
                <Key>DBInstanceIdentifier</Key>
                <Value>mariadb-instance</Value>
              </member>
            </Parameters>
            <ApplyModes>
              <member>immediately</member>
            </ApplyModes>
            <Status>ready</Status>
            <ContextAttributes>
              <member>
                <Key>resourceArn</Key>
                <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
              </member>
              <member>
                <Key>engineName</Key>
                <Value>mariadb</Value>
              </member>
              <member>
                <Key>recommendedValue</Key>
                <Value>60</Value>
              </member>
            </ContextAttributes>
          </member>
        </RecommendedActions>
        <Category>reliability</Category>
        <Source>RDS</Source>
        <TypeDetection>**[resource-count] resources** don't have Enhanced Monitoring enabled</TypeDetection>
        <TypeRecommendation>Turn on Enhanced Monitoring</TypeRecommendation>
        <Impact>Reduced operational visibility</Impact>
        <AdditionalInfo>Enhanced Monitoring for Amazon RDS provides additional visibility on the health of your DB instances. We recommend that you turn on Enhanced Monitoring. When the Enhanced Monitoring option is turned on for your DB instance, it collects vital operating system metrics and process information.</AdditionalInfo>
        <Links>
          <member>
            <Text>Turning Enhanced Monitoring on and off</Text>
            <Url>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html</Url>
          </member>
        </Links>
      </member>
    </DBRecommendations>
  </DescribeDBRecommendationsResult>
</DescribeDBRecommendationsResponse>
```

## See Also
<a name="API_DescribeDBRecommendations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBRecommendations) 

# DescribeDBSecurityGroups
<a name="API_DescribeDBSecurityGroups"></a>

Returns a list of `DBSecurityGroup` descriptions. If a `DBSecurityGroupName` is specified, the list will contain only the descriptions of the specified DB security group.

**Note**  
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-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_DescribeDBSecurityGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSecurityGroupName **   
The name of the DB security group to return details for.  
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBSecurityGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBSecurityGroups_ResponseElements"></a>

The following elements are returned by the service.

 **DBSecurityGroups.DBSecurityGroup.N**   
A list of `DBSecurityGroup` instances.  
Type: Array of [DBSecurityGroup](API_DBSecurityGroup.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBSecurityGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBSecurityGroups_Examples"></a>

### Example
<a name="API_DescribeDBSecurityGroups_Example_1"></a>

This example illustrates one usage of DescribeDBSecurityGroups.

#### Sample Request
<a name="API_DescribeDBSecurityGroups_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBSecurityGroups
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=b14bcddedcf2fd7ffbbcc45ed2caa99cd848ee309a19070f946ad2a54f5331fe
```

#### Sample Response
<a name="API_DescribeDBSecurityGroups_Example_1_Response"></a>

```
<DescribeDBSecurityGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBSecurityGroupsResult>
    <DBSecurityGroups>
      <DBSecurityGroup>
        <EC2SecurityGroups/>
        <DBSecurityGroupDescription>My security group</DBSecurityGroupDescription>
        <IPRanges>
          <IPRange>
            <CIDRIP>192.0.0.0/24</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
          <IPRange>
            <CIDRIP>190.0.1.0/29</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
          <IPRange>
            <CIDRIP>190.0.2.0/29</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
          <IPRange>
            <CIDRIP>10.0.0.0/8</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
        </IPRanges>
        <OwnerId>803#########</OwnerId>
        <DBSecurityGroupName>my-secgrp</DBSecurityGroupName>
      </DBSecurityGroup>
      <DBSecurityGroup>
        <EC2SecurityGroups/>
        <DBSecurityGroupDescription>default</DBSecurityGroupDescription>
        <IPRanges/>
        <OwnerId>803#########</OwnerId>
        <DBSecurityGroupName>default</DBSecurityGroupName>
      </DBSecurityGroup>
   </DBSecurityGroups>
  </DescribeDBSecurityGroupsResult>
  <ResponseMetadata>
    <RequestId>b76e692c-b98c-11d3-a907-5a2c468b9cb0</RequestId>
  </ResponseMetadata>
</DescribeDBSecurityGroupsResponse>
```

## See Also
<a name="API_DescribeDBSecurityGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSecurityGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSecurityGroups) 

# DescribeDBShardGroups
<a name="API_DescribeDBShardGroups"></a>

Describes existing Aurora Limitless Database DB shard groups.

## Request Parameters
<a name="API_DescribeDBShardGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBShardGroupIdentifier **   
The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match an existing DB shard group identifier.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB shard groups to describe.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBShardGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

## Response Elements
<a name="API_DescribeDBShardGroups_ResponseElements"></a>

The following elements are returned by the service.

 **DBShardGroups.DBShardGroup.N**   
Contains a list of DB shard groups for the user.  
Type: Array of [DBShardGroup](API_DBShardGroup.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeDBClusters` request.  
Type: String

## Errors
<a name="API_DescribeDBShardGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBShardGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBShardGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBShardGroups) 

# DescribeDBSnapshotAttributes
<a name="API_DescribeDBSnapshotAttributes"></a>

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, `DescribeDBSnapshotAttributes` returns the `restore` attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If `all` is included in the list of values for the `restore` attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the `ModifyDBSnapshotAttribute` API action.

## Request Parameters
<a name="API_DescribeDBSnapshotAttributes_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSnapshotIdentifier **   
The identifier for the DB snapshot to describe the attributes for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeDBSnapshotAttributes_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshotAttributesResult **   
Contains the results of a successful call to the `DescribeDBSnapshotAttributes` API action.  
Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the `ModifyDBSnapshotAttribute` API action.  
Type: [DBSnapshotAttributesResult](API_DBSnapshotAttributesResult.md) object

## Errors
<a name="API_DescribeDBSnapshotAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBSnapshotAttributes_Examples"></a>

### Example
<a name="API_DescribeDBSnapshotAttributes_Example_1"></a>

This example illustrates one usage of DescribeDBSnapshotAttributes.

#### Sample Request
<a name="API_DescribeDBSnapshotAttributes_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeDBSnapshotAttributes
    &DBSnapshotIdentifier=manual-snapshot1
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20151027/us-east-1/rds/aws4_request
    &X-Amz-Date=20151027T210706Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=27413f450dfac3d68b2197453e52109bacd3863f9df1a02d6e40022165bb2e09
```

#### Sample Response
<a name="API_DescribeDBSnapshotAttributes_Example_1_Response"></a>

```
<DescribeDBSnapshotAttributesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBSnapshotAttributesResult>
    <DBSnapshotAttributesResult>
      <DBSnapshotAttributes>
        <DBSnapshotAttribute>
          <AttributeName>restore</AttributeName>
          <AttributeValues>
            <AttributeValue>012345678901</AttributeValue>
          </AttributeValues>
        </DBSnapshotAttribute>
      </DBSnapshotAttributes>
      <DBSnapshotIdentifier>manual-snapshot1</DBSnapshotIdentifier>
    </DBSnapshotAttributesResult>
  </DescribeDBSnapshotAttributesResult>
  <ResponseMetadata>
    <RequestId>ae5be4a2-7cee-11e5-a056-f1c189649a47</RequestId>
  </ResponseMetadata>
</DescribeDBSnapshotAttributesResponse>
```

## See Also
<a name="API_DescribeDBSnapshotAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSnapshotAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSnapshotAttributes) 

# DescribeDBSnapshots
<a name="API_DescribeDBSnapshots"></a>

Returns information about DB snapshots. This API action supports pagination.

## Request Parameters
<a name="API_DescribeDBSnapshots_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match the identifier of an existing DBInstance.
Type: String  
Required: No

 ** DbiResourceId **   
A specific DB resource ID to describe.  
Type: String  
Required: No

 ** DBSnapshotIdentifier **   
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.  
Constraints:  
+ If supplied, must match the identifier of an existing DBSnapshot.
+ If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified.
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more DB snapshots to describe.  
Supported filters:  
+  `db-instance-id` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
+  `db-snapshot-id` - Accepts DB snapshot identifiers.
+  `dbi-resource-id` - Accepts identifiers of source DB instances.
+  `snapshot-type` - Accepts types of DB snapshots.
+  `engine` - Accepts names of database engines.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IncludePublic **   
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.  
You can share a manual DB snapshot as public by using the [ModifyDBSnapshotAttribute](API_ModifyDBSnapshotAttribute.md) API.  
This setting doesn't apply to RDS Custom.  
Type: Boolean  
Required: No

 ** IncludeShared **   
Specifies whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.  
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the `ModifyDBSnapshotAttribute` API action.  
This setting doesn't apply to RDS Custom.  
Type: Boolean  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** SnapshotType **   
The type of snapshots to be returned. You can specify one of the following values:  
+  `automated` - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.
+  `manual` - Return all DB snapshots that have been taken by my AWS account.
+  `shared` - Return all manual DB snapshots that have been shared to my AWS account.
+  `public` - Return all DB snapshots that have been marked as public.
+  `awsbackup` - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the [https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html) 

  The `awsbackup` type does not apply to Aurora.
If you don't specify a `SnapshotType` value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the `IncludeShared` parameter. You can include public snapshots with these results by enabling the `IncludePublic` parameter.  
The `IncludeShared` and `IncludePublic` parameters don't apply for `SnapshotType` values of `manual` or `automated`. The `IncludePublic` parameter doesn't apply when `SnapshotType` is set to `shared`. The `IncludeShared` parameter doesn't apply when `SnapshotType` is set to `public`.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeDBSnapshots_ResponseElements"></a>

The following elements are returned by the service.

 **DBSnapshots.DBSnapshot.N**   
A list of `DBSnapshot` instances.  
Type: Array of [DBSnapshot](API_DBSnapshot.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBSnapshots_Examples"></a>

### Example
<a name="API_DescribeDBSnapshots_Example_1"></a>

This example illustrates one usage of DescribeDBSnapshots.

#### Sample Request
<a name="API_DescribeDBSnapshots_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBSnapshots
   &IncludePublic=false
   &IncludeShared=true
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20210621/us-west-2/rds/aws4_request
   &X-Amz-Date=20210621T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4aa31bdcf7b5e00dadffbd6dc8448a31871e283ffe270e77890e15487354bcca
```

#### Sample Response
<a name="API_DescribeDBSnapshots_Example_1_Response"></a>

```
<DescribeDBSnapshotsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBSnapshotsResult>
    <DBSnapshots>
      <DBSnapshot>
        <Port>3306</Port>
        <OptionGroupName>default:mysql-5-6</OptionGroupName>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <SnapshotType>manual</SnapshotType>
        <LicenseModel>general-public-license</LicenseModel>
        <EngineVersion>5.6.44</EngineVersion>
        <DBInstanceIdentifier>my-mysqlexampledb</DBInstanceIdentifier>
        <DBSnapshotIdentifier>my-test-restore-snapshot</DBSnapshotIdentifier>
        <SnapshotCreateTime>2021-03-28T19:57:16.707Z</SnapshotCreateTime>
        <OriginalSnapshotCreateTime>2021-03-28T19:57:16.707Z</OriginalSnapshotCreateTime>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <InstanceCreateTime>2021-01-29T22:58:24.231Z</InstanceCreateTime>
        <PercentProgress>100</PercentProgress>
        <AllocatedStorage>5</AllocatedStorage>
        <MasterUsername>awsmyuser</MasterUsername>
      </DBSnapshot>
      <DBSnapshot>
        <Port>3306</Port>
        <OptionGroupName>default:mysql-5-6</OptionGroupName>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <SnapshotType>automated</SnapshotType>
        <LicenseModel>general-public-license</LicenseModel>
         <EngineVersion>5.6.44</EngineVersion>
        <DBInstanceIdentifier>my-mysqlexampledb</DBInstanceIdentifier>
        <DBSnapshotIdentifier>rds:my-mysqlexampledb-2021-04-19-10-08</DBSnapshotIdentifier>
        <SnapshotCreateTime>2021-05-11T06:02:03.422Z</SnapshotCreateTime>
        <OriginalSnapshotCreateTime>2021-04-27T08:16:05.356Z</OriginalSnapshotCreateTime>      
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <InstanceCreateTime>2021-01-29T22:58:24.231Z</InstanceCreateTime>
        <PercentProgress>100</PercentProgress>
        <AllocatedStorage>5</AllocatedStorage>
        <MasterUsername>awsmyuser</MasterUsername>
      </DBSnapshot>
      <DBSnapshot>
        <Port>3306</Port>
        <OptionGroupName>default:mysql-5-6</OptionGroupName>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <SnapshotType>automated</SnapshotType>
        <LicenseModel>general-public-license</LicenseModel>
        <EngineVersion>5.6.44</EngineVersion>
        <DBInstanceIdentifier>my-mysqlexampledb</DBInstanceIdentifier>
        <DBSnapshotIdentifier>rds:my-mysqlexampledb-2021-04-20-10-09</DBSnapshotIdentifier>
        <SnapshotCreateTime>2021-04-20T10:09:15.446Z</SnapshotCreateTime>
        <OriginalSnapshotCreateTime>2021-04-20T10:09:15.446Z</OriginalSnapshotCreateTime>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <InstanceCreateTime>2021-01-29T22:58:24.231Z</InstanceCreateTime>
        <PercentProgress>100</PercentProgress>
        <AllocatedStorage>5</AllocatedStorage>
        <MasterUsername>awsmyuser</MasterUsername>
      </DBSnapshot>
    </DBSnapshots>
  </DescribeDBSnapshotsResult>
  <ResponseMetadata>
    <RequestId>b7769930-b98c-11d3-f272-7cd6cce12cc5</RequestId>
  </ResponseMetadata>
</DescribeDBSnapshotsResponse>
```

## See Also
<a name="API_DescribeDBSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSnapshots) 

# DescribeDBSnapshotTenantDatabases
<a name="API_DescribeDBSnapshotTenantDatabases"></a>

Describes 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 databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

## Request Parameters
<a name="API_DescribeDBSnapshotTenantDatabases_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match the identifier of an existing `DBInstance`.
Type: String  
Required: No

 ** DbiResourceId **   
A specific DB resource identifier to describe.  
Type: String  
Required: No

 ** DBSnapshotIdentifier **   
The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.  
Constraints:  
+ If you specify this parameter, the value must match the ID of an existing DB snapshot.
+ If you specify an automatic snapshot, you must also specify `SnapshotType`.
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more tenant databases to describe.  
Supported filters:  
+  `tenant-db-name` - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
+  `tenant-database-resource-id` - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
+  `dbi-resource-id` - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
+  `db-instance-id` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
+  `db-snapshot-id` - Accepts DB snapshot identifiers.
+  `snapshot-type` - Accepts types of DB snapshots.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeDBSnapshotTenantDatabases` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

 ** SnapshotType **   
The type of DB snapshots to be returned. You can specify one of the following values:  
+  `automated` – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
+  `manual` – All DB snapshots that have been taken by my Amazon Web Services account.
+  `shared` – All manual DB snapshots that have been shared to my Amazon Web Services account.
+  `public` – All DB snapshots that have been marked as public.
+  `awsbackup` – All DB snapshots managed by the AWS Backup service.
Type: String  
Required: No

## Response Elements
<a name="API_DescribeDBSnapshotTenantDatabases_ResponseElements"></a>

The following elements are returned by the service.

 **DBSnapshotTenantDatabases.DBSnapshotTenantDatabase.N**   
A list of DB snapshot tenant databases.  
Type: Array of [DBSnapshotTenantDatabase](API_DBSnapshotTenantDatabase.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBSnapshotTenantDatabases_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeDBSnapshotTenantDatabases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSnapshotTenantDatabases) 

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

## Request Parameters
<a name="API_DescribeDBSubnetGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSubnetGroupName **   
The name of the DB subnet group to return details for.  
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

The following elements are returned by the service.

 **DBSubnetGroups.DBSubnetGroup.N**   
A list of `DBSubnetGroup` instances.  
Type: Array of [DBSubnetGroup](API_DBSubnetGroup.md) objects

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeDBSubnetGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeDBSubnetGroups_Examples"></a>

### Example
<a name="API_DescribeDBSubnetGroups_Example_1"></a>

This example illustrates one usage of DescribeDBSubnetGroups.

#### Sample Request
<a name="API_DescribeDBSubnetGroups_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBSubnetGroups
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=6cc9b2825866148e1d6290b8aa2e9d75b1884b116d8665759942d87ebfbed426
```

#### Sample Response
<a name="API_DescribeDBSubnetGroups_Example_1_Response"></a>

```
<DescribeDBSubnetGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBSubnetGroupsResult>
    <DBSubnetGroups>
      <DBSubnetGroup>
        <VpcId>vpc-e7abbdce</VpcId>
        <SubnetGroupStatus>Complete</SubnetGroupStatus>
        <DBSubnetGroupDescription>DB subnet group 1</DBSubnetGroupDescription>
        <DBSubnetGroupName>mydbsubnetgroup1</DBSubnetGroupName>
        <Subnets>
          <Subnet>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetIdentifier>subnet-e8b3e5b1</SubnetIdentifier>
            <SubnetAvailabilityZone>
              <Name>us-west-2a</Name>
              <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetIdentifier>subnet-44b2f22e</SubnetIdentifier>
            <SubnetAvailabilityZone>
              <Name>us-west-2b</Name>
              <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            </SubnetAvailabilityZone>
          </Subnet>
        </Subnets>
      </DBSubnetGroup>
      <DBSubnetGroup>
        <VpcId>vpc-c1e17bb8</VpcId>
        <SubnetGroupStatus>Complete</SubnetGroupStatus>
        <DBSubnetGroupDescription>My DB subnet group 2</DBSubnetGroupDescription>
        <DBSubnetGroupName>sub-grp-2</DBSubnetGroupName>
        <Subnets>
          <Subnet>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetIdentifier>subnet-d281ef8a</SubnetIdentifier>
            <SubnetAvailabilityZone>
              <Name>us-west-2a</Name>
              <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetIdentifier>subnet-b381ef9f</SubnetIdentifier>
            <SubnetAvailabilityZone>
              <Name>us-west-2c</Name>
              <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetIdentifier>subnet-e1e17ebd</SubnetIdentifier>
            <SubnetAvailabilityZone>
              <Name>us-west-2b</Name>
              <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            </SubnetAvailabilityZone>
          </Subnet>
        </Subnets>
      </DBSubnetGroup>
    </DBSubnetGroups>
  </DescribeDBSubnetGroupsResult>
  <ResponseMetadata>
    <RequestId>b783db3b-b98c-11d3-fbc7-5c0aad74da7c</RequestId>
  </ResponseMetadata>
</DescribeDBSubnetGroupsResponse>
```

## See Also
<a name="API_DescribeDBSubnetGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeDBSubnetGroups) 

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_DescribeEngineDefaultClusterParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupFamily **   
The name of the DB cluster parameter group family to return engine parameter information for.  
Type: String  
Required: Yes

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeEngineDefaultClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

The following element is returned by the service.

 ** EngineDefaults **   
Contains the result of a successful invocation of the `DescribeEngineDefaultParameters` action.  
Type: [EngineDefaults](API_EngineDefaults.md) object

## Errors
<a name="API_DescribeEngineDefaultClusterParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeEngineDefaultClusterParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeEngineDefaultClusterParameters) 

# DescribeEngineDefaultParameters
<a name="API_DescribeEngineDefaultParameters"></a>

Returns the default engine and system parameter information for the specified database engine.

## Request Parameters
<a name="API_DescribeEngineDefaultParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupFamily **   
The name of the DB parameter group family.  
Valid Values:  
+  `aurora-mysql5.7` 
+  `aurora-mysql8.0` 
+  `aurora-postgresql10` 
+  `aurora-postgresql11` 
+  `aurora-postgresql12` 
+  `aurora-postgresql13` 
+  `aurora-postgresql14` 
+  `custom-oracle-ee-19` 
+  `custom-oracle-ee-cdb-19` 
+  `db2-ae` 
+  `db2-se` 
+  `mariadb10.2` 
+  `mariadb10.3` 
+  `mariadb10.4` 
+  `mariadb10.5` 
+  `mariadb10.6` 
+  `mysql5.7` 
+  `mysql8.0` 
+  `oracle-ee-19` 
+  `oracle-ee-cdb-19` 
+  `oracle-ee-cdb-21` 
+  `oracle-se2-19` 
+  `oracle-se2-cdb-19` 
+  `oracle-se2-cdb-21` 
+  `postgres10` 
+  `postgres11` 
+  `postgres12` 
+  `postgres13` 
+  `postgres14` 
+  `sqlserver-ee-11.0` 
+  `sqlserver-ee-12.0` 
+  `sqlserver-ee-13.0` 
+  `sqlserver-ee-14.0` 
+  `sqlserver-ee-15.0` 
+  `sqlserver-ex-11.0` 
+  `sqlserver-ex-12.0` 
+  `sqlserver-ex-13.0` 
+  `sqlserver-ex-14.0` 
+  `sqlserver-ex-15.0` 
+  `sqlserver-se-11.0` 
+  `sqlserver-se-12.0` 
+  `sqlserver-se-13.0` 
+  `sqlserver-se-14.0` 
+  `sqlserver-se-15.0` 
+  `sqlserver-web-11.0` 
+  `sqlserver-web-12.0` 
+  `sqlserver-web-13.0` 
+  `sqlserver-web-14.0` 
+  `sqlserver-web-15.0` 
Type: String  
Required: Yes

 **Filters.Filter.N**   
A filter that specifies one or more parameters to describe.  
The only supported filter is `parameter-name`. The results list only includes information about the parameters with these names.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeEngineDefaultParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeEngineDefaultParameters_ResponseElements"></a>

The following element is returned by the service.

 ** EngineDefaults **   
Contains the result of a successful invocation of the `DescribeEngineDefaultParameters` action.  
Type: [EngineDefaults](API_EngineDefaults.md) object

## Errors
<a name="API_DescribeEngineDefaultParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeEngineDefaultParameters_Examples"></a>

### Example
<a name="API_DescribeEngineDefaultParameters_Example_1"></a>

This example illustrates one usage of DescribeEngineDefaultParameters.

#### Sample Request
<a name="API_DescribeEngineDefaultParameters_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeEngineDefaultParameters
   &DBParameterGroupFamily=mysql5.1
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=747cc243a8a2385b0b06a9e2d145d08b905a39620b2782edd8382ea1712cf826
```

#### Sample Response
<a name="API_DescribeEngineDefaultParameters_Example_1_Response"></a>

```
<DescribeEngineDefaultParametersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeEngineDefaultParametersResult>
    <EngineDefaults>
      <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
      <Marker>bG9nX3FZXJpZ4Nfbm90X3VzaW5nX2luZGV4Z1M=</Marker>
      <Parameters>
        <Parameter>
          <DataType>boolean</DataType>
          <Source>engine-default</Source>
          <IsModifiable>false</IsModifiable>
          <Description>Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded</Description>
          <ApplyType>static</ApplyType>
          <AllowedValues>0,1</AllowedValues>
          <ParameterName>allow-suspicious-udfs</ParameterName>
        </Parameter>
        <Parameter>
          <DataType>integer</DataType>
          <Source>engine-default</Source>
          <IsModifiable>true</IsModifiable>
          <Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description>
          <ApplyType>dynamic</ApplyType>
          <AllowedValues>1-65535</AllowedValues>
          <ParameterName>auto_increment_increment</ParameterName>
        </Parameter>
        <Parameter>
          <DataType>integer</DataType>
          <Source>engine-default</Source>
          <IsModifiable>true</IsModifiable>
          <Description>Determines the starting point for the AUTO_INCREMENT column value</Description>
          <ApplyType>dynamic</ApplyType>
          <AllowedValues>1-65535</AllowedValues>
          <ParameterName>auto_increment_offset</ParameterName>
        </Parameter>
      </Parameters>
    </EngineDefaults>
  </DescribeEngineDefaultParametersResult>
  <ResponseMetadata>
    <RequestId>b789ce01-b98c-11d3-a907-5a2c468b9cb0</RequestId>
  </ResponseMetadata>
</DescribeEngineDefaultParametersResponse>
```

## See Also
<a name="API_DescribeEngineDefaultParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeEngineDefaultParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeEngineDefaultParameters) 

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

Displays 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 [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html).

## Request Parameters
<a name="API_DescribeEventCategories_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** SourceType **   
The type of source that is generating the events. For RDS Proxy events, specify `db-proxy`.  
Valid Values: `db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot` \$1 `db-proxy`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeEventCategories_ResponseElements"></a>

The following element is returned by the service.

 **EventCategoriesMapList.EventCategoriesMap.N**   
A list of `EventCategoriesMap` data types.  
Type: Array of [EventCategoriesMap](API_EventCategoriesMap.md) objects

## Errors
<a name="API_DescribeEventCategories_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeEventCategories_Examples"></a>

### Example
<a name="API_DescribeEventCategories_Example_1"></a>

This example illustrates one usage of DescribeEventCategories.

#### Sample Request
<a name="API_DescribeEventCategories_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeEventCategories
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
```

#### Sample Response
<a name="API_DescribeEventCategories_Example_1_Response"></a>

```
<DescribeEventCategoriesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeEventCategoriesResult>
    <EventCategoriesMapList>
      <EventCategoriesMap>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
          <EventCategory>recovery</EventCategory>
          <EventCategory>restoration</EventCategory>
          <EventCategory>failover</EventCategory>
          <EventCategory>low storage</EventCategory>
          <EventCategory>maintenance</EventCategory>
          <EventCategory>deletion</EventCategory>
          <EventCategory>availability</EventCategory>
          <EventCategory>configuration change</EventCategory>
          <EventCategory>notification</EventCategory>
          <EventCategory>failure</EventCategory>
          <EventCategory>creation</EventCategory>
        </EventCategories>
      </EventCategoriesMap>
      <EventCategoriesMap>
        <SourceType>db-security-group</SourceType>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
          <EventCategory>failure</EventCategory>
        </EventCategories>
      </EventCategoriesMap>
      <EventCategoriesMap>
        <SourceType>db-parameter-group</SourceType>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
        </EventCategories>
      </EventCategoriesMap>
      <EventCategoriesMap>
        <SourceType>db-snapshot</SourceType>
        <EventCategories>
          <EventCategory>deletion</EventCategory>
          <EventCategory>restoration</EventCategory>
          <EventCategory>notification</EventCategory>
          <EventCategory>failure</EventCategory>
          <EventCategory>creation</EventCategory>
        </EventCategories>
      </EventCategoriesMap>
    </EventCategoriesMap>
  </DescribeEventCategoriesResult>
  <ResponseMetadata>
    <RequestId>b79456f2-b98c-11d3-f272-7cd6cce12cc5</RequestId>
  </ResponseMetadata>
</DescribeEventCategoriesResponse>
```

## See Also
<a name="API_DescribeEventCategories_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeEventCategories) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Returns 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 group, or RDS Proxy can be obtained by providing the name as a parameter.

For more information on working with events, see [Monitoring Amazon RDS events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html) in the *Amazon RDS User Guide* and [Monitoring Amazon Aurora events](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html) in the *Amazon Aurora User Guide*.

**Note**  
By default, RDS returns events that were generated in the past hour.

## Request Parameters
<a name="API_DescribeEvents_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Duration **   
The number of minutes to retrieve events for.  
Default: 60  
Type: Integer  
Required: No

 ** EndTime **   
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.](http://en.wikipedia.org/wiki/ISO_8601)   
Example: 2009-07-08T18:00Z  
Type: Timestamp  
Required: No

 **EventCategories.EventCategory.N**   
A list of event categories that trigger notifications for a event notification subscription.  
Type: Array of strings  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** SourceIdentifier **   
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.  
Constraints:  
+ If `SourceIdentifier` is supplied, `SourceType` must also be provided.
+ If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied.
+ If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied.
+ If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied.
+ If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied.
+ If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied.
+ If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied.
+ If the source type is an RDS Proxy, a `DBProxyName` value must be supplied.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: No

 ** SourceType **   
The event source to retrieve events for. If no value is specified, all events are returned.  
Type: String  
Valid Values: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot | custom-engine-version | db-proxy | blue-green-deployment | db-shard-group | zero-etl`   
Required: No

 ** StartTime **   
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.](http://en.wikipedia.org/wiki/ISO_8601)   
Example: 2009-07-08T18:00Z  
Type: Timestamp  
Required: No

## Response Elements
<a name="API_DescribeEvents_ResponseElements"></a>

The following elements are returned by the service.

 **Events.Event.N**   
A list of `Event` instances.  
Type: Array of [Event](API_Event.md) objects

 ** Marker **   
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeEvents_Examples"></a>

### Example
<a name="API_DescribeEvents_Example_1"></a>

This example illustrates one usage of DescribeEvents.

#### Sample Request
<a name="API_DescribeEvents_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeEvents
   &Duration=1440
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194733Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8e313cabcdbd9766c56a2886b5b298fd944e0b7cfa248953c82705fdd0374f27
```

#### Sample Response
<a name="API_DescribeEvents_Example_1_Response"></a>

```
<DescribeEventsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeEventsResult>
    <Events>
      <Event>
        <Message>Backing up DB instance</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T06:23:33.866Z</Date>
        <SourceIdentifier>mypgdbinstance</SourceIdentifier>
      </Event>
      <Event>
        <Message>Finished DB Instance backup</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T06:25:03.928Z</Date>
        <SourceIdentifier>mypgdbinstance</SourceIdentifier>
      </Event>
      <Event>
        <Message>Backing up DB instance</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T07:09:34.594Z</Date>
        <SourceIdentifier>my-mysqlexampledb4</SourceIdentifier>
      </Event>
      <Event>
        <Message>Finished DB Instance backup</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T07:11:05.640Z</Date>
        <SourceIdentifier>my-mysqlexampledb4</SourceIdentifier>
      </Event>
      <Event>
        <Message>Backing up DB instance</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T09:26:25.988Z</Date>
        <SourceIdentifier>my-oracledb1</SourceIdentifier>
      </Event>
      <Event>
        <Message>Finished DB Instance backup</Message>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>backup</EventCategory>
        </EventCategories>
        <Date>2014-04-21T09:28:38.048Z</Date>
        <SourceIdentifier>my-oracledb1</SourceIdentifier>
      </Event>
    </Events>
  </DescribeEventsResult>
  <ResponseMetadata>
    <RequestId>b7a8cd43-b98c-11d3-a907-5a2c468b9cb0</RequestId>
  </ResponseMetadata>
</DescribeEventsResponse>
```

## See Also
<a name="API_DescribeEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeEvents) 

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

Lists all the subscription descriptions for a customer account. The description for a subscription includes `SubscriptionName`, `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`, and `Status`.

If you specify a `SubscriptionName`, lists the description for that subscription.

## Request Parameters
<a name="API_DescribeEventSubscriptions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` .  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** SubscriptionName **   
The name of the RDS event notification subscription you want to describe.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

The following elements are returned by the service.

 **EventSubscriptionsList.EventSubscription.N**   
A list of EventSubscriptions data types.  
Type: Array of [EventSubscription](API_EventSubscription.md) objects

 ** Marker **   
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeEventSubscriptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** SubscriptionNotFound **   
The subscription name does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeEventSubscriptions_Examples"></a>

### Example
<a name="API_DescribeEventSubscriptions_Example_1"></a>

This example illustrates one usage of DescribeEventSubscriptions.

#### Sample Request
<a name="API_DescribeEventSubscriptions_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeEventSubscriptions
   &MaxRecords=100
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T161907Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4208679fe967783a1a149c826199080a066085d5a88227a80c6c0cadb3e8c0d4
```

#### Sample Response
<a name="API_DescribeEventSubscriptions_Example_1_Response"></a>

```
<DescribeEventSubscriptionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeEventSubscriptionsResult>
    <EventSubscriptionsList>
      <EventSubscription>
        <Enabled>true</Enabled>
        <CustomerAwsId>802#########</CustomerAwsId>
        <SourceType>db-instance</SourceType>
        <Status>active</Status>
        <SourceIdsList>
          <SourceId>mysqldb-rr</SourceId>
          <SourceId>mysqldb</SourceId>
        </SourceIdsList>
        <SubscriptionCreationTime>2014-04-25 22:01:46.327</SubscriptionCreationTime>
        <EventCategoriesList>
          <EventCategory>creation</EventCategory>
          <EventCategory>deletion</EventCategory>
          <EventCategory>configuration change</EventCategory>
          <EventCategory>low storage</EventCategory>
        </EventCategoriesList>
        <CustSubscriptionId>myawsuser-instance</CustSubscriptionId>
        <SnsTopicArn>arn:aws:sns:us-east-1:802#########:myawsuser-RDS</SnsTopicArn>
      </EventSubscription>
      <EventSubscription>
        <Enabled>true</Enabled>
        <CustomerAwsId>802#########</CustomerAwsId>
        <SourceType>db-parameter-group</SourceType>
        <Status>active</Status>
        <SourceIdsList>
          <SourceId>mydbparametergroup00</SourceId>
        </SourceIdsList>
        <SubscriptionCreationTime>2014-04-25 21:44:44.68</SubscriptionCreationTime>
        <EventCategoriesList>
          <EventCategory>configuration change</EventCategory>
        </EventCategoriesList>
        <CustSubscriptionId>myawsuser-paramgrp</CustSubscriptionId>
        <SnsTopicArn>arn:aws:sns:us-east-1:802#########:myawsuser-RDS</SnsTopicArn>
      </EventSubscription>
      <EventSubscription>
        <Enabled>true</Enabled>
        <CustomerAwsId>802#########</CustomerAwsId>
        <SourceType>db-security-group</SourceType>
        <Status>active</Status>
        <SubscriptionCreationTime>2014-04-25 21:43:25.542</SubscriptionCreationTime>
        <EventCategoriesList>
          <EventCategory>configuration change</EventCategory>
          <EventCategory>failure</EventCategory>
        </EventCategoriesList>
        <CustSubscriptionId>myawsuser-secgrp</CustSubscriptionId>
        <SnsTopicArn>arn:aws:sns:us-east-1:802#########:myawsuser-RDS</SnsTopicArn>
      </EventSubscription>
      <EventSubscription>
        <Enabled>true</Enabled>
        <CustomerAwsId>802#########</CustomerAwsId>
        <SourceType>db-snapshot</SourceType>
        <Status>active</Status>
        <SubscriptionCreationTime>2014-04-25 21:41:24.405</SubscriptionCreationTime>
        <EventCategoriesList>
          <EventCategory>creation</EventCategory>
          <EventCategory>failure</EventCategory>
          <EventCategory>deletion</EventCategory>
        </EventCategoriesList>
        <CustSubscriptionId>myawsuser-snapshot</CustSubscriptionId>
        <SnsTopicArn>arn:aws:sns:us-east-1:802#########:myawsuser-RDS</SnsTopicArn>
      </EventSubscription>
    </EventSubscriptionsList>
  </DescribeEventSubscriptionsResult>
  <ResponseMetadata>
    <RequestId>c2c6da4e-bde9-11d3-fe11-33d33a9bb7e3</RequestId>
  </ResponseMetadata>
</DescribeEventSubscriptionsResponse>
```

## See Also
<a name="API_DescribeEventSubscriptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeEventSubscriptions) 

# DescribeExportTasks
<a name="API_DescribeExportTasks"></a>

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

## Request Parameters
<a name="API_DescribeExportTasks_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ExportTaskIdentifier **   
The identifier of the snapshot or cluster export task to be described.  
Type: String  
Required: No

 **Filters.Filter.N**   
Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.  
Supported filters include the following:  
+  `export-task-identifier` - An identifier for the snapshot or cluster export task.
+  `s3-bucket` - The Amazon S3 bucket the data is exported to.
+  `source-arn` - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
+  `status` - The status of the export task. Must be lowercase. Valid statuses are the following:
  +  `canceled` 
  +  `canceling` 
  +  `complete` 
  +  `failed` 
  +  `in_progress` 
  +  `starting` 
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeExportTasks` request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the `MaxRecords` parameter.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later `DescribeExportTasks` request to retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 100.  
Required: No

 ** SourceArn **   
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.  
Type: String  
Required: No

 ** SourceType **   
The type of source for the export.  
Type: String  
Valid Values: `SNAPSHOT | CLUSTER`   
Required: No

## Response Elements
<a name="API_DescribeExportTasks_ResponseElements"></a>

The following elements are returned by the service.

 **ExportTasks.ExportTask.N**   
Information about an export of a snapshot or cluster to Amazon S3.  
Type: Array of [ExportTask](API_ExportTask.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeExportTasks` request. A marker is used for pagination to identify the location to begin output for the next response of `DescribeExportTasks`.  
Type: String

## Errors
<a name="API_DescribeExportTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ExportTaskNotFound **   
The export task doesn't exist.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeExportTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeExportTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeExportTasks) 

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

**Note**  
This action only applies to Aurora DB clusters.

## Request Parameters
<a name="API_DescribeGlobalClusters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.  
Currently, the only supported filter is `region`.  
If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified AWS Regions.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** GlobalClusterIdentifier **   
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.  
Constraints:  
+ If supplied, must match an existing DBClusterIdentifier.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeGlobalClusters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

The following elements are returned by the service.

 **GlobalClusters.GlobalClusterMember.N**   
The list of global clusters returned by this request.  
Type: Array of [GlobalCluster](API_GlobalCluster.md) objects

 ** Marker **   
An optional pagination token provided by a previous `DescribeGlobalClusters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

## Errors
<a name="API_DescribeGlobalClusters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeGlobalClusters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeGlobalClusters) 

# DescribeIntegrations
<a name="API_DescribeIntegrations"></a>

Describe one or more zero-ETL integrations with Amazon Redshift.

## Request Parameters
<a name="API_DescribeIntegrations_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
A filter that specifies one or more resources to return.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IntegrationIdentifier **   
The unique identifier of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_:\-\/]+`   
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeIntegrations` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 340.  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeIntegrations_ResponseElements"></a>

The following elements are returned by the service.

 **Integrations.Integration.N**   
A list of integrations.  
Type: Array of [Integration](API_Integration.md) objects

 ** Marker **   
A pagination token that can be used in a later `DescribeIntegrations` request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 340.

## Errors
<a name="API_DescribeIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeIntegrations_Examples"></a>

### Example
<a name="API_DescribeIntegrations_Example_1"></a>

This example illustrates one usage of DescribeIntegrations.

#### Sample Request
<a name="API_DescribeIntegrations_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeIntegration
   &IntegrationIdentifier=f30acbd8-aaab-4c3c-afb5-09d51d041037
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-east-1/rds/aws4_request
   &X-Amz-Date=20230110T005253Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_DescribeIntegrations_Example_1_Response"></a>

```
<DescribeIntegrationsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <DescribeIntegrationsResult>
        <Integrations>
            <Integration>
                <SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:serverless-source-cluster</SourceArn>
                <IntegrationName>my-integration</IntegrationName>
                <IntegrationCreateTime>2023-12-14T00:15:21.358Z</IntegrationCreateTime>
                <IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:f30acbd8-aaab-4c3c-afb5-09d51d041037</IntegrationArn>
                <TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/0844171c-1e01-4d9f-be52-89e6c44083e5</TargetArn>
                <Tags/>
                <CreateTime>2023-12-14T00:15:21.358Z</CreateTime>
                <KMSKeyId>arn:aws:kms:us-east-1:211223847500:key/eda7134d-cd39-4af1-b62b-ad2415b6bccc</KMSKeyId>
                <Status>creating</Status>
            </Integration>
        </Integrations>
    </DescribeIntegrationsResult>
    <ResponseMetadata>
        <RequestId>6e131503-e920-4c3d-b934-a401a69c3b24</RequestId>
    </ResponseMetadata>
</DescribeIntegrationsResponse>
```

## See Also
<a name="API_DescribeIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeIntegrations) 

# DescribeOptionGroupOptions
<a name="API_DescribeOptionGroupOptions"></a>

Describes all available options for the specified engine.

## Request Parameters
<a name="API_DescribeOptionGroupOptions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EngineName **   
The name of the engine to describe options for.  
Valid Values:  
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: Yes

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** MajorEngineVersion **   
If specified, filters the results to include only options for the specified major engine version.  
Type: String  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeOptionGroupOptions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **OptionGroupOptions.OptionGroupOption.N**   
List of available option group options.  
Type: Array of [OptionGroupOption](API_OptionGroupOption.md) objects

## Errors
<a name="API_DescribeOptionGroupOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeOptionGroupOptions_Examples"></a>

### Example
<a name="API_DescribeOptionGroupOptions_Example_1"></a>

This example illustrates one usage of DescribeOptionGroupOptions.

#### Sample Request
<a name="API_DescribeOptionGroupOptions_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeOptionGroupOptions
   &EngineName=oracle-se1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194733Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=3792d1669ce65ba1ba6a85b2e4057235e46dd3d0072663c17f4b4439fd8af702
```

#### Sample Response
<a name="API_DescribeOptionGroupOptions_Example_1_Response"></a>

```
<DescribeOptionGroupOptionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeOptionGroupOptionsResult>
    <OptionGroupOptions>
      <OptionGroupOption>
        <MajorEngineVersion>11.2</MajorEngineVersion>
        <PortRequired>false</PortRequired>
        <Persistent>false</Persistent>
        <OptionsDependedOn>
          <OptionName>XMLDB</OptionName>
        </OptionsDependedOn>
        <OptionsConflictsWith/>
        <Permanent>false</Permanent>
        <Description>Oracle Application Express Runtime Environment</Description>
        <Name>APEX</Name>
        <OptionGroupOptionSettings/>
        <EngineName>oracle-se1</EngineName>
        <MinimumRequiredMinorEngineVersion>0.2.v4</MinimumRequiredMinorEngineVersion>
      </OptionGroupOption>
      <OptionGroupOption>
        <MajorEngineVersion>11.2</MajorEngineVersion>
        <PortRequired>false</PortRequired>
        <Persistent>false</Persistent>
        <OptionsDependedOn>
          <OptionName>APEX</OptionName>
        </OptionsDependedOn>
        <OptionsConflictsWith/>
        <Permanent>false</Permanent>
        <Description>Oracle Application Express Development Environment</Description>
        <Name>APEX-DEV</Name>
        <OptionGroupOptionSettings/>
        <EngineName>oracle-se1</EngineName>
        <MinimumRequiredMinorEngineVersion>0.2.v4</MinimumRequiredMinorEngineVersion>
      </OptionGroupOption>
      <OptionGroupOption>
        <MajorEngineVersion>11.2</MajorEngineVersion>
        <PortRequired>true</PortRequired>
        <Persistent>false</Persistent>
        <OptionsDependedOn/>
        <OptionsConflictsWith/>        
        <Permanent>false</Permanent>
        <Description>Oracle Enterprise Manager (Database Control only)</Description>
        <DefaultPort>1158</DefaultPort>
        <Name>OEM</Name>
        <OptionGroupOptionSettings/>
        <EngineName>oracle-se1</EngineName>
        <MinimumRequiredMinorEngineVersion>0.2.v3</MinimumRequiredMinorEngineVersion>
      </OptionGroupOption>
    </OptionGroupOptions>
  </DescribeOptionGroupOptionsResult>
  <ResponseMetadata>
    <RequestId>b7b26a8f-b98c-11d3-f272-7cd6cce12cc5</RequestId>
  </ResponseMetadata>
</DescribeOptionGroupOptionsResponse>
```

## See Also
<a name="API_DescribeOptionGroupOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOptionGroupOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeOptionGroupOptions) 

# DescribeOptionGroups
<a name="API_DescribeOptionGroups"></a>

Describes the available option groups.

## Request Parameters
<a name="API_DescribeOptionGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EngineName **   
A filter to only include option groups associated with this database engine.  
Valid Values:  
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** MajorEngineVersion **   
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.  
Type: String  
Required: No

 ** Marker **   
An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** OptionGroupName **   
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeOptionGroups_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **OptionGroupsList.OptionGroup.N**   
List of option groups.  
Type: Array of [OptionGroup](API_OptionGroup.md) objects

## Errors
<a name="API_DescribeOptionGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeOptionGroups_Examples"></a>

### Example
<a name="API_DescribeOptionGroups_Example_1"></a>

This example illustrates one usage of DescribeOptionGroups.

#### Sample Request
<a name="API_DescribeOptionGroups_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeOptionGroups
   &MaxRecords=100
   &OptionGroupName=myawsuser-grp1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-east-1/rds/aws4_request
   &X-Amz-Date=20140421T231357Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=fabfbeb85c44e3f151d44211790c5135a9074fdb8d85ec117788ac6cfab6c5bc
```

#### Sample Response
<a name="API_DescribeOptionGroups_Example_1_Response"></a>

```
<DescribeOptionGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeOptionGroupsResult>
    <OptionGroupsList>
      <OptionGroup>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>5.6</MajorEngineVersion>
        <OptionGroupName>myawsuser-grp1</OptionGroupName>
        <EngineName>mysql</EngineName>
        <OptionGroupDescription>my test option group</OptionGroupDescription>
        <Options/>
      </OptionGroup>
    </OptionGroupsList>
  </DescribeOptionGroupsResult>
  <ResponseMetadata>
    <RequestId>8c6201fc-b9ff-11d3-f92b-31fa5e8dbc99</RequestId>
  </ResponseMetadata>
</DescribeOptionGroupsResponse>
```

### Example
<a name="API_DescribeOptionGroups_Example_2"></a>

This example illustrates one usage of DescribeOptionGroups.

#### Sample Request
<a name="API_DescribeOptionGroups_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeOptionGroups
    &MaxRecords=100
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140613/us-west-2/rds/aws4_request
    &X-Amz-Date=20140613T223341Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=5ae331adcd684c27d66e0b794a51933effe32a4c026eba2e994ae483ee47a0ba
```

#### Sample Response
<a name="API_DescribeOptionGroups_Example_2_Response"></a>

```
<DescribeOptionGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeOptionGroupsResult>
    <OptionGroupsList>
      <OptionGroup>
        <OptionGroupName>default:mysql-5-5</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>5.5</MajorEngineVersion>
        <EngineName>mysql</EngineName>
        <OptionGroupDescription>Default option group MySQL 5.5</OptionGroupDescription>
        <Options/>
      </OptionGroup>
      <OptionGroup>
        <OptionGroupName>default:postgres-9-3</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>9.3</MajorEngineVersion>
        <EngineName>postgres</EngineName>
        <OptionGroupDescription>Default option group for postgres 9.3</OptionGroupDescription>
        <Options/>
      </OptionGroup>
      <OptionGroup>
        <OptionGroupName>default:sqlserver-ex-10-50</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>10.50</MajorEngineVersion>
        <EngineName>sqlserver-ex</EngineName>
        <OptionGroupDescription>Default option group for sqlserver-ex 10.50</OptionGroupDescription>
        <Options/>
      </OptionGroup>
      <OptionGroup>
        <OptionGroupName>default:sqlserver-se-10-50-mirrored</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>10.50</MajorEngineVersion>
        <EngineName>sqlserver-se</EngineName>
        <OptionGroupDescription>Default Mirroring-enabled option group for sqlserver-se 10.50</OptionGroupDescription>
        <Options>
          <Option>
            <OptionName>Mirroring</OptionName>
            <OptionDescription>SQLServer Database Mirroring</OptionDescription>
            <Persistent>false</Persistent>
            <Permanent>false</Permanent>
            <OptionSettings/>
            <VpcSecurityGroupMemberships/>
            <DBSecurityGroupMemberships/>
          </Option>
        </Options>
      </OptionGroup>
      <OptionGroup>
        <OptionGroupName>default:sqlserver-se-11-00</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>11.00</MajorEngineVersion>
        <EngineName>sqlserver-se</EngineName>
        <OptionGroupDescription>Default option group for sqlserver-se 11.00</OptionGroupDescription>
        <Options/>
      </OptionGroup>
      <OptionGroup>
        <OptionGroupName>myawsuser-opt-grp</OptionGroupName>
        <AllowsVpcAndNonVpcInstanceMemberships>false</AllowsVpcAndNonVpcInstanceMemberships>
        <MajorEngineVersion>11.2</MajorEngineVersion>
        <EngineName>oracle-ee</EngineName>
        <OptionGroupDescription>test option group</OptionGroupDescription>
        <Options>
          <Option>
            <OptionName>NATIVE_NETWORK_ENCRYPTION</OptionName>
            <OptionDescription>Oracle Advanced Security - Native Network Encryption</OptionDescription>
            <Persistent>false</Persistent>
            <Permanent>false</Permanent>
            <OptionSettings>
              <OptionSetting>
                <DataType>STRING</DataType>
                <IsModifiable>true</IsModifiable>
                <IsCollection>true</IsCollection>
                <Description>Specifies list of checksumming algorithms in order of intended use</Description>
                <Name>SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER</Name>
                <Value>SHA1,MD5</Value>
                <ApplyType>STATIC</ApplyType>
                <DefaultValue>SHA1,MD5</DefaultValue>
                <AllowedValues>SHA1,MD5</AllowedValues>
              </OptionSetting>
              <OptionSetting>
                <DataType>STRING</DataType>
                <IsModifiable>true</IsModifiable>
                <IsCollection>true</IsCollection>
                <Description>Specifies list of encryption algorithms in order of intended use</Description>
                <Name>SQLNET.ENCRYPTION_TYPES_SERVER</Name>
                <Value>RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40</Value>
                <ApplyType>STATIC</ApplyType>
                <DefaultValue>RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40</DefaultValue>
                <AllowedValues>RC4_256,AES256,AES192,3DES168,RC4_128,AES128,3DES112,RC4_56,DES,RC4_40,DES40</AllowedValues>
              </OptionSetting>
              <OptionSetting>
                <DataType>STRING</DataType>
                <IsModifiable>true</IsModifiable>
                <IsCollection>false</IsCollection>
                <Description>Specifies the desired encryption behavior</Description>
                <Name>SQLNET.ENCRYPTION_SERVER</Name>
                <Value>REQUESTED</Value>
                <ApplyType>STATIC</ApplyType>
                <DefaultValue>REQUESTED</DefaultValue>
                <AllowedValues>ACCEPTED,REJECTED,REQUESTED,REQUIRED</AllowedValues>
              </OptionSetting>
              <OptionSetting>
                <DataType>STRING</DataType>
                <IsModifiable>true</IsModifiable>
                <IsCollection>false</IsCollection>
                <Description>Specifies the desired data integrity behavior</Description>
                <Name>SQLNET.CRYPTO_CHECKSUM_SERVER</Name>
                <Value>REQUESTED</Value>
                <ApplyType>STATIC</ApplyType>
                <DefaultValue>REQUESTED</DefaultValue>
                <AllowedValues>ACCEPTED,REJECTED,REQUESTED,REQUIRED</AllowedValues>
              </OptionSetting>
            </OptionSettings>
            <VpcSecurityGroupMemberships/>
            <DBSecurityGroupMemberships/>
          </Option>
          <Option>
            <OptionName>XMLDB</OptionName>
            <OptionDescription>Oracle XMLDB Repository</OptionDescription>
            <Persistent>false</Persistent>
            <Permanent>false</Permanent>
            <OptionSettings/>
            <VpcSecurityGroupMemberships/>
            <DBSecurityGroupMemberships/>
          </Option>
          <Option>
            <Port>1158</Port>
            <OptionName>OEM</OptionName>
            <OptionDescription>Oracle Enterprise Manager (Database Control only)</OptionDescription>
            <Persistent>false</Persistent>
            <Permanent>false</Permanent>
            <OptionSettings/>
            <VpcSecurityGroupMemberships/>
            <DBSecurityGroupMemberships>
              <DBSecurityGroup>
                <Status>authorized</Status>
                <DBSecurityGroupName>sg-db-sec-grp</DBSecurityGroupName>
              </DBSecurityGroup>
            </DBSecurityGroupMemberships>
          </Option>
        </Options>
      </OptionGroup>
          <Option>
            <OptionName>APEX</OptionName>
            <OptionDescription>Oracle Application Express Runtime Environment</OptionDescription>
            <Persistent>false</Persistent>
            <Permanent>false</Permanent>
            <OptionSettings/>
            <VpcSecurityGroupMemberships/>
            <DBSecurityGroupMemberships/>
          </Option>
        </Options>
      </OptionGroup>
    </OptionGroupsList>
  </DescribeOptionGroupsResult>
  <ResponseMetadata>
    <RequestId>b2ce0772-f55a-11e3-bd0f-bb88ac05a37c</RequestId>
  </ResponseMetadata>
</DescribeOptionGroupsResponse>
```

## See Also
<a name="API_DescribeOptionGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOptionGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeOptionGroups) 

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

Describes the orderable DB instance options for a specified DB engine.

## Request Parameters
<a name="API_DescribeOrderableDBInstanceOptions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The name of the database engine to describe DB instance options for.  
Valid Values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
+  `custom-oracle-ee` 
+  `custom-oracle-ee-cdb` 
+  `custom-oracle-se2` 
+  `custom-oracle-se2-cdb` 
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: Yes

 ** AvailabilityZoneGroup **   
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.  
Omit this parameter to show the available options in the specified AWS Region.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DBInstanceClass **   
A filter to include only the available options for the specified DB instance class.  
Type: String  
Required: No

 ** EngineVersion **   
A filter to include only the available options for the specified engine version.  
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** LicenseModel **   
A filter to include only the available options for the specified license model.  
RDS Custom supports only the BYOL licensing model.  
Type: String  
Required: No

 ** Marker **   
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 1000.  
Type: Integer  
Required: No

 ** Vpc **   
Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.  
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **OrderableDBInstanceOptions.OrderableDBInstanceOption.N**   
An `OrderableDBInstanceOption` structure containing information about orderable options for the DB instance.  
Type: Array of [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) objects

## Errors
<a name="API_DescribeOrderableDBInstanceOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeOrderableDBInstanceOptions_Examples"></a>

### Example
<a name="API_DescribeOrderableDBInstanceOptions_Example_1"></a>

This example illustrates one usage of DescribeOrderableDBInstanceOptions.

#### Sample Request
<a name="API_DescribeOrderableDBInstanceOptions_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeOrderableDBInstanceOptions
   &Engine=mysql
   &EngineVersion=8.0.26
   &DBInstanceClass=db.r6gd.large
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20211020T205537Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=b49545dd3c933bdded80655d433d84bf743261ea1bebb33a7922c5c2c5240cd8
```

#### Sample Response
<a name="API_DescribeOrderableDBInstanceOptions_Example_1_Response"></a>

```
<DescribeOrderableDBInstanceOptionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeOrderableDBInstanceOptionsResult>
    <Marker>ZGIubTEuc21hbGwKZ2VuZXJhbC1wdWJsaWMtbGljZW5zZQo1LjEuNjkKTg==</Marker>
    <OrderableDBInstanceOptions>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <Vpc>false</Vpc>
        <EngineVersion>5.1.57</EngineVersion>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-west-2a</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-west-2b</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-west-2c</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
        </AvailabilityZones>
        <DBInstanceClass>db.m1.large</DBInstanceClass>
      </OrderableDBInstanceOption>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <Vpc>true</Vpc>
        <EngineVersion>5.1.57</EngineVersion>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-west-2a</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-west-2b</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-west-2c</Name>
            <ProvisionedIopsCapable>true</ProvisionedIopsCapable>
          </AvailabilityZone>
        </AvailabilityZones>
        <DBInstanceClass>db.m1.large</DBInstanceClass>
      </OrderableDBInstanceOption>
    </OrderableDBInstanceOptions>
  </DescribeOrderableDBInstanceOptionsResult>
  <ResponseMetadata>
    <RequestId>b7ceb73e-b98c-11d3-a907-5a2c468b9cb0</RequestId>
  </ResponseMetadata>
</DescribeOrderableDBInstanceOptionsResponse>
```

## See Also
<a name="API_DescribeOrderableDBInstanceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeOrderableDBInstanceOptions) 

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

Returns 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 this in mind when you use `DescribePendingMaintenanceActions` immediately after using a previous API command such as `ApplyPendingMaintenanceActions`.

## Request Parameters
<a name="API_DescribePendingMaintenanceActions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
A filter that specifies one or more resources to return pending maintenance actions for.  
Supported filters:  
+  `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.
+  `db-instance-id` - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribePendingMaintenanceActions` request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** ResourceIdentifier **   
The ARN of a resource to return pending maintenance actions for.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous `DescribePendingMaintenanceActions` request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by `MaxRecords`.  
Type: String

 **PendingMaintenanceActions.ResourcePendingMaintenanceActions.N**   
A list of the pending maintenance actions for the resource.  
Type: Array of [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) objects

## Errors
<a name="API_DescribePendingMaintenanceActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribePendingMaintenanceActions_Examples"></a>

### Example
<a name="API_DescribePendingMaintenanceActions_Example_1"></a>

This example illustrates one usage of DescribePendingMaintenanceActions.

#### Sample Request
<a name="API_DescribePendingMaintenanceActions_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribePendingMaintenanceActions
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141216/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
```

#### Sample Response
<a name="API_DescribePendingMaintenanceActions_Example_1_Response"></a>

```
<DescribePendingMaintenanceActionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribePendingMaintenanceActionsResult>
    <PendingMaintenanceActions>
      <ResourcePendingMaintenanceActions>
        <ResourceIdentifier>arn:aws:rds:us-east-1:123456781234:db:my-instance</ResourceIdentifier>
        <PendingMaintenanceActionDetails>
          <PendingMaintenanceAction>
            <Action>system-update</Action>
          </PendingMaintenanceAction>
        </PendingMaintenanceActionDetails>
      </ResourcePendingMaintenanceActions>
      <ResourcePendingMaintenanceActions>
        <ResourceIdentifier>arn:aws:rds:us-east-1:123456781234:db:another-instance</ResourceIdentifier>
        <PendingMaintenanceActionDetails>
          <PendingMaintenanceAction>
            <Action>system-update</Action>
          </PendingMaintenanceAction>
        </PendingMaintenanceActionDetails>
      </ResourcePendingMaintenanceActions>
    </PendingMaintenanceActions>
  </DescribePendingMaintenanceActionsResult>
  <ResponseMetadata>
    <RequestId>dcfe0682-870c-11e4-9833-b3ad657ea9da</RequestId>
  </ResponseMetadata>
</DescribePendingMaintenanceActionsResponse>
```

## See Also
<a name="API_DescribePendingMaintenanceActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribePendingMaintenanceActions) 

# DescribeReservedDBInstances
<a name="API_DescribeReservedDBInstances"></a>

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

## Request Parameters
<a name="API_DescribeReservedDBInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceClass **   
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.  
Type: String  
Required: No

 ** Duration **   
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.  
Valid Values: `1 | 3 | 31536000 | 94608000`   
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** LeaseId **   
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.  
 AWS Support might request the lease ID for an issue related to a reserved DB instance.
Type: String  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** MultiAZ **   
Specifies whether to show only those reservations that support Multi-AZ.  
Type: Boolean  
Required: No

 ** OfferingType **   
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.  
Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `   
Type: String  
Required: No

 ** ProductDescription **   
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.  
Type: String  
Required: No

 ** ReservedDBInstanceId **   
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.  
Type: String  
Required: No

 ** ReservedDBInstancesOfferingId **   
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeReservedDBInstances_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **ReservedDBInstances.ReservedDBInstance.N**   
A list of reserved DB instances.  
Type: Array of [ReservedDBInstance](API_ReservedDBInstance.md) objects

## Errors
<a name="API_DescribeReservedDBInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ReservedDBInstanceNotFound **   
The specified reserved DB Instance not found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeReservedDBInstances_Examples"></a>

### Example
<a name="API_DescribeReservedDBInstances_Example_1"></a>

This example illustrates one usage of DescribeReservedDBInstances.

#### Sample Request
<a name="API_DescribeReservedDBInstances_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeReservedDBInstances
   &ReservedDBInstanceId=customerSpecifiedID
   &SignatureMethod=HmacSHA256 
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-west-2/rds/aws4_request
   &X-Amz-Date=20140420T162211Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=3312d17a4c43bcd209bc22a0778dd23e73f8434254abbd7ac53b89ade3dae88e
```

#### Sample Response
<a name="API_DescribeReservedDBInstances_Example_1_Response"></a>

```
<DescribeReservedDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeReservedDBInstancesResult>
    <ReservedDBInstances>
      <ReservedDBInstance>
        <OfferingType>Partial Upfront</OfferingType>
        <CurrencyCode>USD</CurrencyCode>
        <RecurringCharges/>
        <ProductDescription>mysql</ProductDescription>
        <ReservedDBInstancesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedDBInstancesOfferingId>
        <MultiAZ>false</MultiAZ>
        <State>active</State>
        <ReservedDBInstanceId>myreservationid</ReservedDBInstanceId>
        <DBInstanceCount>1</DBInstanceCount>
        <StartTime>2014-05-15T00:25:14.131Z</StartTime>
        <Duration>31536000</Duration>
        <FixedPrice>227.5</FixedPrice>
        <UsagePrice>0.046</UsagePrice>
        <DBInstanceClass>db.m1.small</DBInstanceClass>
      </ReservedDBInstance>      
  </DescribeReservedDBInstancesResult>
  <ResponseMetadata>
    <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedDBInstancesResponse>
```

## See Also
<a name="API_DescribeReservedDBInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeReservedDBInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeReservedDBInstances) 

# DescribeReservedDBInstancesOfferings
<a name="API_DescribeReservedDBInstancesOfferings"></a>

Lists available reserved DB instance offerings.

## Request Parameters
<a name="API_DescribeReservedDBInstancesOfferings_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceClass **   
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.  
Type: String  
Required: No

 ** Duration **   
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.  
Valid Values: `1 | 3 | 31536000 | 94608000`   
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** MultiAZ **   
Specifies whether to show only those reservations that support Multi-AZ.  
Type: Boolean  
Required: No

 ** OfferingType **   
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.  
Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `   
Type: String  
Required: No

 ** ProductDescription **   
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.  
The results show offerings that partially match the filter value.
Type: String  
Required: No

 ** ReservedDBInstancesOfferingId **   
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.  
Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeReservedDBInstancesOfferings_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **ReservedDBInstancesOfferings.ReservedDBInstancesOffering.N**   
A list of reserved DB instance offerings.  
Type: Array of [ReservedDBInstancesOffering](API_ReservedDBInstancesOffering.md) objects

## Errors
<a name="API_DescribeReservedDBInstancesOfferings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ReservedDBInstancesOfferingNotFound **   
Specified offering does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeReservedDBInstancesOfferings_Examples"></a>

### Example
<a name="API_DescribeReservedDBInstancesOfferings_Example_1"></a>

This example illustrates one usage of DescribeReservedDBInstancesOfferings.

#### Sample Request
<a name="API_DescribeReservedDBInstancesOfferings_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeReservedDBInstancesOfferings
   &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140411/us-east-1/rds/aws4_request
   &X-Amz-Date=20140411T203327Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=545f04acffeb4b80d2e778526b1c9da79d0b3097151c24f28e83e851d65422e2
```

#### Sample Response
<a name="API_DescribeReservedDBInstancesOfferings_Example_1_Response"></a>

```
<DescribeReservedDBInstancesOfferingsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeReservedDBInstancesOfferingsResult>
    <ReservedDBInstancesOfferings>
      <ReservedDBInstancesOffering>
        <Duration>31536000</Duration>
        <OfferingType>Partial Upfront</OfferingType>
        <CurrencyCode>USD</CurrencyCode>
        <RecurringCharges>          
          <RecurringCharge>
            <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>
            <RecurringChargeAmount>0.123</RecurringChargeAmount>
          </RecurringCharge>
        </RecurringCharges>
        <FixedPrice>162.0</FixedPrice>
        <ProductDescription>mysql</ProductDescription>
        <UsagePrice>0.0</UsagePrice>
        <MultiAZ>false</MultiAZ>
        <ReservedDBInstancesOfferingId>SampleOfferingId</ReservedDBInstancesOfferingId>
        <DBInstanceClass>db.m1.small</DBInstanceClass>
      </ReservedDBInstancesOffering>
    </ReservedDBInstancesOfferings>
  </DescribeReservedDBInstancesOfferingsResult>
  <ResponseMetadata>
    <RequestId>521b420a-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedDBInstancesOfferingsResponse>
```

## See Also
<a name="API_DescribeReservedDBInstancesOfferings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeReservedDBInstancesOfferings) 

# DescribeServerlessV2PlatformVersions
<a name="API_DescribeServerlessV2PlatformVersions"></a>

Describes the properties of specific platform versions for Aurora Serverless v2.

## Request Parameters
<a name="API_DescribeServerlessV2PlatformVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DefaultOnly **   
Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.  
Type: Boolean  
Required: No

 ** Engine **   
The database engine to return platform version details for.  
Valid Values:  
+  `aurora-mysql` 
+  `aurora-postgresql` 
Type: String  
Required: No

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** IncludeAll **   
Specifies whether to also include platform versions which are no longer in use.  
Type: Boolean  
Required: No

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more than the `MaxRecords` value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 20  
Constraints: Minimum 1, maximum 200.  
Type: Integer  
Required: No

 ** ServerlessV2PlatformVersion **   
A specific platform version to return details for.  
Example: `3`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeServerlessV2PlatformVersions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **ServerlessV2PlatformVersions.member.N**   
A list of `ServerlessV2PlatformVersionInfo` elements.  
Type: Array of [ServerlessV2PlatformVersionInfo](API_ServerlessV2PlatformVersionInfo.md) objects

## Errors
<a name="API_DescribeServerlessV2PlatformVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeServerlessV2PlatformVersions_Examples"></a>

### Example
<a name="API_DescribeServerlessV2PlatformVersions_Example_1"></a>

This example illustrates one usage of DescribeServerlessV2PlatformVersions.

#### Sample Request
<a name="API_DescribeServerlessV2PlatformVersions_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=DescribeServerlessV2PlatformVersions
    &MaxRecords=3
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20260331/us-east-1/rds/aws4_request
    &X-Amz-Date=20260331T003734Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=a9be10ebb18697cfb30621749934561405d97a3e836a749e92080dda950dbdfb
```

#### Sample Response
<a name="API_DescribeServerlessV2PlatformVersions_Example_1_Response"></a>

```
<DescribeServerlessV2PlatformVersionsResponse>
  <DescribeServerlessV2PlatformVersionsResult>
    <ServerlessV2PlatformVersions>
      <member>
        <IsDefault>true</IsDefault>
        <ServerlessV2PlatformVersionDescription>
          Version 4 offering scaling up to 256 ACUs, and performance improvement up to 30% compared to version 3
        </ServerlessV2PlatformVersionDescription>
        <Engine>aurora-postgresql</Engine>
        <ServerlessV2FeaturesSupport>
        <MaxCapacity>256.0</MaxCapacity>
        <MinCapacity>0.0</MinCapacity>
        </ServerlessV2FeaturesSupport>
        <ServerlessV2PlatformVersion>4</ServerlessV2PlatformVersion>
        <Status>enabled</Status>
      </member>
      <member>
        <IsDefault>false</IsDefault>
        <ServerlessV2PlatformVersionDescription>
          Version 3 offering scaling up to 256 ACUs, and performance improvement up to 30% compared to version 2
        </ServerlessV2PlatformVersionDescription>
        <Engine>aurora-postgresql</Engine>
        <ServerlessV2FeaturesSupport>
        <MaxCapacity>256.0</MaxCapacity>
        <MinCapacity>0.0</MinCapacity>
        </ServerlessV2FeaturesSupport>
        <ServerlessV2PlatformVersion>3</ServerlessV2PlatformVersion>
        <Status>enabled</Status>
      </member>
      <member>
        <IsDefault>false</IsDefault>
        <ServerlessV2PlatformVersionDescription>
          Version 2 offering scaling up to 256 ACUs
        </ServerlessV2PlatformVersionDescription>
        <Engine>aurora-postgresql</Engine>
        <ServerlessV2FeaturesSupport>
        <MaxCapacity>256.0</MaxCapacity>
        <MinCapacity>0.0</MinCapacity>
        </ServerlessV2FeaturesSupport>
        <ServerlessV2PlatformVersion>2</ServerlessV2PlatformVersion>
        <Status>enabled</Status>
      </member>
    </ServerlessV2PlatformVersions>
    <Marker>dGhpcyBpcyBhbiBleGFtcGxlIG1hcmtlcg==</Marker>
  </DescribeServerlessV2PlatformVersionsResult>
  <ResponseMetadata>
    <RequestId>a1da1a67-9f9a-43d0-975c-5800dc1b1f59</RequestId>
  </ResponseMetadata>
</DescribeServerlessV2PlatformVersionsResponse>
```

## See Also
<a name="API_DescribeServerlessV2PlatformVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeServerlessV2PlatformVersions) 

# DescribeSourceRegions
<a name="API_DescribeSourceRegions"></a>

Returns a list of the source AWS Regions where the current AWS 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 current Region. This operation supports pagination.

To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation `DescribeRegions`. For more information, see [ DescribeRegions](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html) in the *Amazon EC2 API Reference*.

## Request Parameters
<a name="API_DescribeSourceRegions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeSourceRegions` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.  
Default: 100  
Constraints: Minimum 20, maximum 100.  
Type: Integer  
Required: No

 ** RegionName **   
The source AWS Region name. For example, `us-east-1`.  
Constraints:  
+ Must specify a valid AWS Region name.
Type: String  
Required: No

## Response Elements
<a name="API_DescribeSourceRegions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **SourceRegions.SourceRegion.N**   
A list of `SourceRegion` instances that contains each source AWS Region that the current AWS Region can get a read replica or a DB snapshot from.  
Type: Array of [SourceRegion](API_SourceRegion.md) objects

## Errors
<a name="API_DescribeSourceRegions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeSourceRegions_Examples"></a>

### Example
<a name="API_DescribeSourceRegions_Example_1"></a>

This example illustrates one usage of DescribeSourceRegions.

#### Sample Request
<a name="API_DescribeSourceRegions_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeSourceRegions
   &MaxRecords=10
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request
   &X-Amz-Date=20140429T175351Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2
```

#### Sample Response
<a name="API_DescribeSourceRegions_Example_1_Response"></a>

```
<DescribeSourceRegionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeSourceRegionsResult>       
    <SourceRegions>
      <SourceRegion>
        <RegionName>ap-northeast-1</RegionName>
        <EndPoint>https://rds.ap-northeast-1.amazonaws.com</EndPoint>
        <Status>available</Status>       
      </SourceRegion>
      <SourceRegion>
        <RegionName>ap-southeast-2</RegionName>
        <EndPoint>https://rds.ap-southeast-2.amazonaws.com</EndPoint>
        <Status>available</Status>       
      </SourceRegion>
    </SourceRegions>
  </DescribeSourceRegionsResult>
  <ResponseMetadata>
    <RequestId>01b2685a-b978-11d3-f272-7cd6cce12cc5</RequestId>
  </ResponseMetadata>
</DescribeSourceRegionsResponse>
```

## See Also
<a name="API_DescribeSourceRegions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeSourceRegions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeSourceRegions) 

# DescribeTenantDatabases
<a name="API_DescribeTenantDatabases"></a>

Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.

## Request Parameters
<a name="API_DescribeTenantDatabases_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the AWS account. This parameter isn't case-sensitive.  
Type: String  
Required: No

 **Filters.Filter.N**   
A filter that specifies one or more database tenants to describe.  
Supported filters:  
+  `tenant-db-name` - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
+  `tenant-database-resource-id` - Tenant database resource identifiers.
+  `dbi-resource-id` - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional pagination token provided by a previous `DescribeTenantDatabases` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.  
Type: Integer  
Required: No

 ** TenantDBName **   
The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your AWS account. This parameter isn’t case-sensitive.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeTenantDatabases_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional pagination token provided by a previous `DescribeTenantDatabases` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **TenantDatabases.TenantDatabase.N**   
An array of the tenant databases requested by the `DescribeTenantDatabases` operation.  
Type: Array of [TenantDatabase](API_TenantDatabase.md) objects

## Errors
<a name="API_DescribeTenantDatabases_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeTenantDatabases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeTenantDatabases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeTenantDatabases) 

# DescribeValidDBInstanceModifications
<a name="API_DescribeValidDBInstanceModifications"></a>

You can call `DescribeValidDBInstanceModifications` to learn what modifications you can make to your DB instance. You can use this information when you call `ModifyDBInstance`.

This command doesn't apply to RDS Custom.

## Request Parameters
<a name="API_DescribeValidDBInstanceModifications_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The customer identifier or the ARN of your DB instance.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeValidDBInstanceModifications_ResponseElements"></a>

The following element is returned by the service.

 ** ValidDBInstanceModificationsMessage **   
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the `DescribeValidDBInstanceModifications` action. You can use this information when you call `ModifyDBInstance`.  
Type: [ValidDBInstanceModificationsMessage](API_ValidDBInstanceModificationsMessage.md) object

## Errors
<a name="API_DescribeValidDBInstanceModifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeValidDBInstanceModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DescribeValidDBInstanceModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DescribeValidDBInstanceModifications) 

# DisableHttpEndpoint
<a name="API_DisableHttpEndpoint"></a>

Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.

For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the `EnableHttpEndpoint` parameter of the `ModifyDBCluster` operation.

## Request Parameters
<a name="API_DisableHttpEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the DB cluster.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DisableHttpEndpoint_ResponseElements"></a>

The following elements are returned by the service.

 ** HttpEndpointEnabled **   
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.  
Type: Boolean

 ** ResourceArn **   
The ARN of the DB cluster.  
Type: String

## Errors
<a name="API_DisableHttpEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidResourceStateFault **   
The operation can't be performed because another operation is in progress.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_DisableHttpEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DisableHttpEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DisableHttpEndpoint) 

# DownloadDBLogFilePortion
<a name="API_DownloadDBLogFilePortion"></a>

Downloads all or a portion of the specified log file, up to 1 MB in size.

This command doesn't apply to RDS Custom.

**Note**  
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 information, see [GetLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) in the *Amazon CloudWatch Logs API Reference*.

## Request Parameters
<a name="API_DownloadDBLogFilePortion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The customer-assigned name of the DB instance that contains the log files you want to list.  
Constraints:  
+ Must match the identifier of an existing DBInstance.
Type: String  
Required: Yes

 ** LogFileName **   
The name of the log file to be downloaded.  
Type: String  
Required: Yes

 ** Marker **   
The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.  
Type: String  
Required: No

 ** NumberOfLines **   
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.  
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.  
+ If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
+ If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
+ If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
+ You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Type: Integer  
Required: No

## Response Elements
<a name="API_DownloadDBLogFilePortion_ResponseElements"></a>

The following elements are returned by the service.

 ** AdditionalDataPending **   
A Boolean value that, if true, indicates there is more data to be downloaded.  
Type: Boolean

 ** LogFileData **   
Entries from the specified log file.  
Type: String

 ** Marker **   
A pagination token that can be used in a later `DownloadDBLogFilePortion` request.  
Type: String

## Errors
<a name="API_DownloadDBLogFilePortion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBInstanceNotReady **   
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.  
HTTP Status Code: 400

 ** DBLogFileNotFoundFault **   
 `LogFileName` doesn't refer to an existing DB log file.  
HTTP Status Code: 404

## Examples
<a name="API_DownloadDBLogFilePortion_Examples"></a>

### Example
<a name="API_DownloadDBLogFilePortion_Example_1"></a>

This example illustrates one usage of DownloadDBLogFilePortion.

#### Sample Request
<a name="API_DownloadDBLogFilePortion_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
  ?Action=DownloadDBLogFilePortion
  &DBInstanceIdentifier=myexampledb
  &LogFileName=log%2FERROR
  &Marker=0
  &NumberOfLines=50
  &Version=2014-10-31
  &X-Amz-Algorithm=AWS4-HMAC-SHA256
  &X-Amz-Credential=AKIADQKE4SARGYLE/20140127/us-west-2/rds/aws4_request
  &X-Amz-Date=20140127T235259Z
  &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
  &X-Amz-Signature=2171c5a8e91a70202e77de7e81df75787f3bbd6b4ea97f7a426205474fcc446f
```

#### Sample Response
<a name="API_DownloadDBLogFilePortion_Example_1_Response"></a>

```
<DownloadDBLogFilePortionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DownloadDBLogFilePortionResult>
    <Marker>0:4485</Marker>
    <LogFileData>??2014-01-26 23:59:00.01 spid54      Microsoft SQL Server 2012 - 11.0.2100.60 (X64) 
    
    Feb 10 2012 19:39:15 
    
    Copyright (c) Microsoft Corporation
    
    Web Edition (64-bit) on Windows NT 6.1 &lt;X64&gt; (Build 7601: Service Pack 1) (Hypervisor)
    
    
    
2014-01-26 23:59:00.01 spid54      (c) Microsoft Corporation.

2014-01-26 23:59:00.01 spid54      All rights reserved.

2014-01-26 23:59:00.01 spid54      Server process ID is 2976.

2014-01-26 23:59:00.01 spid54      System Manufacturer: 'Xen', System Model: 'HVM domU'.

2014-01-26 23:59:00.01 spid54      Authentication mode is MIXED.

2014-01-26 23:59:00.01 spid54      Logging SQL Server messages in file 'D:\RDSDBDATA\Log\ERROR'.

2014-01-26 23:59:00.01 spid54      The service account is 'WORKGROUP\AMAZONA-NUQUUMV$'. This is an informational message; no user action is required.

2014-01-26 23:59:00.01 spid54      The error log has been reinitialized. See the previous log for older entries.

2014-01-27 00:00:56.42 spid25s     This instance of SQL Server has been using a process ID of 2976 since 10/21/2013 2:16:50 AM (local) 10/21/2013 2:16:50 AM (UTC). This is an informational message only; no user action is required.

2014-01-27 09:35:15.43 spid71      I/O is frozen on database model. No user action is required. However, if I/O is not resumed promptly, you could cancel the backup.

2014-01-27 09:35:15.44 spid72      I/O is frozen on database msdb. No user action is required. However, if I/O is not resumed promptly, you could cancel the backup.

2014-01-27 09:35:15.44 spid74      I/O is frozen on database rdsadmin. No user action is required. However, if I/O is not resumed promptly, you could cancel the backup.

2014-01-27 09:35:15.44 spid73      I/O is frozen on database master. No user action is required. However, if I/O is not resumed promptly, you could cancel the backup.

2014-01-27 09:35:25.57 spid73      I/O was resumed on database master. No user action is required.

2014-01-27 09:35:25.57 spid74      I/O was resumed on database rdsadmin. No user action is required.

2014-01-27 09:35:25.57 spid71      I/O was resumed on database model. No user action is required.

2014-01-27 09:35:25.57 spid72      I/O was resumed on database msdb. No user action is required.


</LogFileData>
    <AdditionalDataPending>false</AdditionalDataPending>
  </DownloadDBLogFilePortionResult>
  <ResponseMetadata>
    <RequestId>27143425-87ae-11e3-acc9-fb64b157268e</RequestId>
  </ResponseMetadata>
</DownloadDBLogFilePortionResponse>
```

## See Also
<a name="API_DownloadDBLogFilePortion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/DownloadDBLogFilePortion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/DownloadDBLogFilePortion) 

# EnableHttpEndpoint
<a name="API_EnableHttpEndpoint"></a>

Enables 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 query editor.

For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the `EnableHttpEndpoint` parameter of the `ModifyDBCluster` operation.

## Request Parameters
<a name="API_EnableHttpEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the DB cluster.  
Type: String  
Required: Yes

## Response Elements
<a name="API_EnableHttpEndpoint_ResponseElements"></a>

The following elements are returned by the service.

 ** HttpEndpointEnabled **   
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.  
Type: Boolean

 ** ResourceArn **   
The ARN of the DB cluster.  
Type: String

## Errors
<a name="API_EnableHttpEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidResourceStateFault **   
The operation can't be performed because another operation is in progress.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_EnableHttpEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/EnableHttpEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/EnableHttpEndpoint) 

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

Forces 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 internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_FailoverDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing DB cluster.
Type: String  
Required: Yes

 ** TargetDBInstanceIdentifier **   
The name of the DB instance to promote to the primary DB instance.  
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example `mydbcluster-replica1`.  
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.  
Type: String  
Required: No

## Response Elements
<a name="API_FailoverDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_FailoverDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_FailoverDBCluster_Examples"></a>

### Example
<a name="API_FailoverDBCluster_Example_1"></a>

This example illustrates one usage of FailoverDBCluster.

#### Sample Request
<a name="API_FailoverDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=FailoverDBCluster
    &DBClusterIdentifier=sample-cluster
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150323/us-east-1/rds/aws4_request
    &X-Amz-Date=20150323T170232Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=9be705fa28a68244d5072722463a29a322f9ef8eb58a63c40a6f6547174dec44
```

#### Sample Response
<a name="API_FailoverDBCluster_Example_1_Response"></a>

```
<FailoverDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <FailoverDBClusterResult>
    <DBCluster>
      <Port>3306</Port>
      <LatestRestorableTime>2015-03-23T17:00:54.893Z</LatestRestorableTime>
      <Engine>aurora</Engine>
      <Status>available</Status>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <Status>active</Status>
          <VpcSecurityGroupId>sg-922dc2fd</VpcSecurityGroupId>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <DBSubnetGroup>sample-group</DBSubnetGroup>
      <EngineVersion>5.6.10a</EngineVersion>
      <Endpoint>sample-cluster.cluster-c1axbpgwvdfo.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <PreferredBackupWindow>05:47-06:17</PreferredBackupWindow>
      <PreferredMaintenanceWindow>mon:10:16-mon:10:46</PreferredMaintenanceWindow>
      <EarliestRestorableTime>2015-03-04T23:08:59.159Z</EarliestRestorableTime>
      <DBClusterMembers>
        <DBClusterMember>
          <IsClusterWriter>false</IsClusterWriter>
          <DBInstanceIdentifier>sample-replica1</DBInstanceIdentifier>
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
        </DBClusterMember>
        <DBClusterMember>
          <IsClusterWriter>true</IsClusterWriter>
          <DBInstanceIdentifier>sample-primary</DBInstanceIdentifier>
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
        </DBClusterMember>
      </DBClusterMembers>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>awsuser</MasterUsername>
    </DBCluster>
  </FailoverDBClusterResult>
  <ResponseMetadata>
    <RequestId>659c3dba-d17e-11e4-9fd0-35e9d88e2515</RequestId>
  </ResponseMetadata>
</FailoverDBClusterResponse>
```

## See Also
<a name="API_FailoverDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/FailoverDBCluster) 

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

Promotes 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."

**Note**  
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) operation instead.

How you use this operation depends on whether you are failing over or switching over your global database cluster:
+ Failing over - Specify the `AllowDataLoss` parameter and don't specify the `Switchover` parameter.
+ Switching over - Specify the `Switchover` parameter or omit it, but don't specify the `AllowDataLoss` parameter.

 **About failing over and switching over** 

While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
+  *Failing over* - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

  For more information about failing over an Amazon Aurora global database, see [Performing managed failovers for Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned) in the *Amazon Aurora User Guide*.
+  *Switching over* - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

  For more information about switching over an Amazon Aurora global database, see [Performing switchovers for Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalClusterIdentifier **   
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.  
Constraints:  
+ Must match the identifier of an existing global database cluster.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** TargetDbClusterIdentifier **   
The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its AWS Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** AllowDataLoss **   
Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.  
If you don't specify `AllowDataLoss`, the global database cluster operation defaults to a switchover.  
Constraints:  
+ Can't be specified together with the `Switchover` parameter.
Type: Boolean  
Required: No

 ** Switchover **   
Specifies whether to switch over this global database cluster.  
Constraints:  
+ Can't be specified together with the `AllowDataLoss` parameter.
Type: Boolean  
Required: No

## Response Elements
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_FailoverGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## See Also
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/FailoverGlobalCluster) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see [ Constructing an ARN for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the *Amazon RDS User Guide*.  
Type: String  
Required: Yes

 **Filters.Filter.N**   
This parameter isn't currently supported.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

The following element is returned by the service.

 **TagList.Tag.N**   
List of tags returned by the `ListTagsForResource` operation.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSnapshotTenantDatabaseNotFoundFault **   
The specified snapshot tenant database wasn't found.  
HTTP Status Code: 404

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

 ** TenantDatabaseNotFound **   
The specified tenant database wasn't found in the DB instance.  
HTTP Status Code: 404

## Examples
<a name="API_ListTagsForResource_Examples"></a>

### Example
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ListTagsForResource
    &ResourceName=arn%3Aaws%3Ards%3Aus-west-2%3A12345678910%3Adb%3Asample-sql
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160304/us-west-2/rds/aws4_request
    &X-Amz-Date=20160304T205529Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=ad333e422a92110b6340a28a684f0ed78606cc48b29b25682df0173e04b93b85
```

#### Sample Response
<a name="API_ListTagsForResource_Example_1_Response"></a>

```
<ListTagsForResourceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ListTagsForResourceResult>
    <TagList>
      <Tag>
        <Value>development-team</Value>
        <Key>owner</Key>
      </Tag>
      <Tag>
        <Value>test</Value>
        <Key>environment</Key>
      </Tag>
    </TagList>
  </ListTagsForResourceResult>
  <ResponseMetadata>
    <RequestId>71217a3c-e24b-11e5-a5e9-cad172f9e6c1</RequestId>
  </ResponseMetadata>
</ListTagsForResourceResponse>
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ListTagsForResource) 

# ModifyActivityStream
<a name="API_ModifyActivityStream"></a>

Changes 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 stream. Restarting the activity stream isn't required. For more information, see [ Modifying a database activity stream](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html) in the *Amazon RDS User Guide*. 

This operation is supported for RDS for Oracle and Microsoft SQL Server.

## Request Parameters
<a name="API_ModifyActivityStream_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AuditPolicyState **   
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.  
Type: String  
Valid Values: `locked | unlocked`   
Required: No

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, `arn:aws:rds:us-east-1:12345667890:db:my-orcl-db`.  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyActivityStream_ResponseElements"></a>

The following elements are returned by the service.

 ** EngineNativeAuditFieldsIncluded **   
Indicates whether engine-native audit fields are included in the database activity stream.  
Type: Boolean

 ** KinesisStreamName **   
The name of the Amazon Kinesis data stream to be used for the database activity stream.  
Type: String

 ** KmsKeyId **   
The AWS KMS key identifier for encryption of messages in the database activity stream.  
Type: String

 ** Mode **   
The mode of the database activity stream.  
Type: String  
Valid Values: `sync | async` 

 ** PolicyStatus **   
The status of the modification to the policy state of the database activity stream.  
Type: String  
Valid Values: `locked | unlocked | locking-policy | unlocking-policy` 

 ** Status **   
The status of the modification to the database activity stream.  
Type: String  
Valid Values: `stopped | starting | started | stopping` 

## Errors
<a name="API_ModifyActivityStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_ModifyActivityStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyActivityStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyActivityStream) 

# ModifyCertificates
<a name="API_ModifyCertificates"></a>

Override 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 certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

You might need to override the default certificate in the following situations:
+ You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region.
+ RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

For more information about rotating your SSL/TLS certificate for RDS DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide*.

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_ModifyCertificates_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CertificateIdentifier **   
The new default certificate identifier to override the current one with.  
To determine the valid values, use the `describe-certificates` AWS CLI command or the `DescribeCertificates` API operation.  
Type: String  
Required: No

 ** RemoveCustomerOverride **   
Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_ModifyCertificates_ResponseElements"></a>

The following element is returned by the service.

 ** Certificate **   
A CA certificate for an AWS account.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: [Certificate](API_Certificate.md) object

## Errors
<a name="API_ModifyCertificates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

## See Also
<a name="API_ModifyCertificates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyCertificates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyCertificates) 

# ModifyCurrentDBClusterCapacity
<a name="API_ModifyCurrentDBClusterCapacity"></a>

Set 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 `ModifyCurrentDBClusterCapacity` to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless v1, see [Using Amazon Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*.

**Important**  
If you call `ModifyCurrentDBClusterCapacity` with the default `TimeoutAction`, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see [ Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*.

**Note**  
This operation only applies to Aurora Serverless v1 DB clusters.

## Request Parameters
<a name="API_ModifyCurrentDBClusterCapacity_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing DB cluster.
Type: String  
Required: Yes

 ** Capacity **   
The DB cluster capacity.  
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.  
Constraints:  
+ For Aurora MySQL, valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`.
+ For Aurora PostgreSQL, valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `192`, and `384`.
Type: Integer  
Required: No

 ** SecondsBeforeTimeout **   
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.  
Specify a value between 10 and 600 seconds.  
Type: Integer  
Required: No

 ** TimeoutAction **   
The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange`.  
 `ForceApplyCapacityChange`, the default, sets the capacity to the specified value as soon as possible.  
 `RollbackCapacityChange` ignores the capacity change if a scaling point isn't found in the timeout period.  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyCurrentDBClusterCapacity_ResponseElements"></a>

The following elements are returned by the service.

 ** CurrentCapacity **   
The current capacity of the DB cluster.  
Type: Integer

 ** DBClusterIdentifier **   
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.  
Type: String

 ** PendingCapacity **   
A value that specifies the capacity that the DB cluster scales to next.  
Type: Integer

 ** SecondsBeforeTimeout **   
The number of seconds before a call to `ModifyCurrentDBClusterCapacity` times out.  
Type: Integer

 ** TimeoutAction **   
The timeout action of a call to `ModifyCurrentDBClusterCapacity`, either `ForceApplyCapacityChange` or `RollbackCapacityChange`.  
Type: String

## Errors
<a name="API_ModifyCurrentDBClusterCapacity_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterCapacityFault **   
 `Capacity` isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyCurrentDBClusterCapacity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyCurrentDBClusterCapacity) 

# ModifyCustomDBEngineVersion
<a name="API_ModifyCustomDBEngineVersion"></a>

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling `DescribeDBEngineVersions`.

**Note**  
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with AWS CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the `ModifyCustomDbEngineVersion` event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the `ModifyCustomDbEngineVersion` event.

For more information, see [Modifying CEV status](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_ModifyCustomDBEngineVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The database engine.  
RDS Custom for Oracle supports the following values:  
+  `custom-oracle-ee` 
+  `custom-oracle-ee-cdb` 
+  `custom-oracle-se2` 
+  `custom-oracle-se2-cdb` 
RDS Custom for SQL Server supports the following values:  
+  `custom-sqlserver-ee` 
+  `custom-sqlserver-se` 
+  `ccustom-sqlserver-web` 
+  `custom-sqlserver-dev` 
RDS for SQL Server supports only `sqlserver-dev-ee`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[A-Za-z0-9-]{1,35}`   
Required: Yes

 ** EngineVersion **   
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of `Engine` and `EngineVersion` is unique per customer per AWS Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `[a-z0-9_.-]{1,60}`   
Required: Yes

 ** Description **   
An optional description of your CEV.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** Status **   
The availability status to be assigned to the CEV. Valid values are as follows:    
available  
You can use this CEV to create a new RDS Custom DB instance.  
inactive  
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from `available` to `inactive`, and from `inactive` back to `available`. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.  
Type: String  
Valid Values: `available | inactive | inactive-except-restore`   
Required: No

## Response Elements
<a name="API_ModifyCustomDBEngineVersion_ResponseElements"></a>

The following elements are returned by the service.

 ** CreateTime **   
The creation time of the DB engine version.  
Type: Timestamp

 ** CustomDBEngineVersionManifest **   
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see [JSON fields in the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) in the *Amazon RDS User Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51000.  
Pattern: `[\s\S]*` 

 **DatabaseInstallationFiles.member.N**   
The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. Required for `sqlserver-dev-ee`.  
Type: Array of strings

 ** DatabaseInstallationFilesS3BucketName **   
The name of the Amazon S3 bucket that contains your database installation files.  
Type: String

 ** DatabaseInstallationFilesS3Prefix **   
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.  
Type: String

 ** DBEngineDescription **   
The description of the database engine.  
Type: String

 ** DBEngineMediaType **   
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.  
Type: String

 ** DBEngineVersionArn **   
The ARN of the custom engine version.  
Type: String

 ** DBEngineVersionDescription **   
The description of the database engine version.  
Type: String

 ** DBParameterGroupFamily **   
The name of the DB parameter group family for the database engine.  
Type: String

 ** DefaultCharacterSet **   
The default character set for new instances of this engine version, if the `CharacterSetName` parameter of the CreateDBInstance API isn't specified.  
Type: [CharacterSet](API_CharacterSet.md) object

 ** Engine **   
The name of the database engine.  
Type: String

 ** EngineVersion **   
The version number of the database engine.  
Type: String

 **ExportableLogTypes.member.N**   
The types of logs that the database engine has available for export to CloudWatch Logs.  
Type: Array of strings

 ** FailureReason **   
The reason that the custom engine version creation for `sqlserver-dev-ee` failed with an `incompatible-installation-media` status.  
Type: String

 ** Image **   
The EC2 image  
Type: [CustomDBEngineVersionAMI](API_CustomDBEngineVersionAMI.md) object

 ** KMSKeyId **   
The AWS KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.  
Type: String

 ** MajorEngineVersion **   
The major engine version of the CEV.  
Type: String

 ** ServerlessV2FeaturesSupport **   
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.   
Type: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) object

 ** Status **   
The status of the DB engine version, either `available` or `deprecated`.  
Type: String

 **SupportedCACertificateIdentifiers.member.N**   
A list of the supported CA certificate identifiers.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: Array of strings

 **SupportedCharacterSets.CharacterSet.N**   
A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedEngineModes.member.N**   
A list of the supported DB engine modes.  
Type: Array of strings

 **SupportedFeatureNames.member.N**   
A list of features supported by the DB engine.  
The supported features vary by DB engine and DB engine version.  
To determine the supported features for a specific DB engine and DB engine version using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>`   
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the AWS CLI, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --engine-version 13.3`   
The supported features are listed under `SupportedFeatureNames` in the output.  
Type: Array of strings

 **SupportedNcharCharacterSets.CharacterSet.N**   
A list of the character sets supported by the Oracle DB engine for the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation.  
Type: Array of [CharacterSet](API_CharacterSet.md) objects

 **SupportedTimezones.Timezone.N**   
A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action.  
Type: Array of [Timezone](API_Timezone.md) objects

 ** SupportsBabelfish **   
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.  
Type: Boolean

 ** SupportsCertificateRotationWithoutRestart **   
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.  
Type: Boolean

 ** SupportsGlobalDatabases **   
Indicates whether you can use Aurora global databases with a specific DB engine version.  
Type: Boolean

 ** SupportsIntegrations **   
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.  
Type: Boolean

 ** SupportsLimitlessDatabase **   
Indicates whether the DB engine version supports Aurora Limitless Database.  
Type: Boolean

 ** SupportsLocalWriteForwarding **   
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.  
Valid for: Aurora DB clusters only  
Type: Boolean

 ** SupportsLogExportsToCloudwatchLogs **   
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.  
Type: Boolean

 ** SupportsParallelQuery **   
Indicates whether you can use Aurora parallel query with a specific DB engine version.  
Type: Boolean

 ** SupportsReadReplica **   
Indicates whether the database engine version supports read replicas.  
Type: Boolean

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 **ValidUpgradeTarget.UpgradeTarget.N**   
A list of engine versions that this database engine version can be upgraded to.  
Type: Array of [UpgradeTarget](API_UpgradeTarget.md) objects

## Errors
<a name="API_ModifyCustomDBEngineVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CustomDBEngineVersionNotFoundFault **   
The specified CEV was not found.  
HTTP Status Code: 404

 ** InvalidCustomDBEngineVersionStateFault **   
You can't delete the CEV.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyCustomDBEngineVersion_Examples"></a>

### Example
<a name="API_ModifyCustomDBEngineVersion_Example_1"></a>

This example illustrates one usage of ModifyCustomDBEngineVersion.

#### Sample Request
<a name="API_ModifyCustomDBEngineVersion_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Engine=19.cev1
   &EngineVersion=custom-oracle-ee
   &Description=test
   &Status=available
   &Operation=ModifyCustomDBEngineVersion
   &Version=1999-01-01
   &AWSAccessKeyId=ABCDEF1JKLMNOPQRSTUV
   &SignatureVersion=2
   &SignatureMethod=HmacSHA1
   &Timestamp=2021-10-13T21%3A38%3A59.000Z
   &Signature=vJeEgn2kGiAyCI7uRVAOXqGPiHc%3D
```

#### Sample Response
<a name="API_ModifyCustomDBEngineVersion_Example_1_Response"></a>

```
<ModifyCustomDBEngineVersionResponse xmlns="http://rds.amazonaws.com/doc/1999-01-01/">
  <ModifyCustomDBEngineVersionResult>
    <DatabaseInstallationFilesS3Prefix>123456789012/cev1</DatabaseInstallationFilesS3Prefix>
    <MajorEngineVersion>19</MajorEngineVersion>
    <DBEngineVersionArn>arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee/19.cev1/123ab45c-abc1-1234-1234-123a45b12345</DBEngineVersionArn>    <DBEngineVersionDescription>foo</DBEngineVersionDescription>
    <SupportsGlobalDatabases>false</SupportsGlobalDatabases>
    <SupportsParallelQuery>false</SupportsParallelQuery>
    <Engine>custom-oracle-ee</Engine>
    <KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/12ab3c4d-1234-12a3-1aa2-12a3bcdefghi</KMSKeyId>
    <EngineVersion>19.cev1</EngineVersion>
    <SupportsReadReplica>false</SupportsReadReplica>
    <SupportsCluster>false</SupportsCluster>
    <CreateTime>2021-07-03T00:41:23.515Z</CreateTime>
    <DatabaseInstallationFilesS3BucketName>1-custom-installation-files</DatabaseInstallationFilesS3BucketName>
    <SupportsLogExportsToCloudwatchLogs>false</SupportsLogExportsToCloudwatchLogs>
    <AMIs>
      <member>
        <Id>ami-0230ab8f4967332aa</Id>
        <Status>active</Status>
      </member>
    </AMIs>
    <DBEngineDescription>Oracle Database server EE for Custom</DBEngineDescription>
    <Status>available</Status>
  </ModifyCustomDBEngineVersionResult>
  <ResponseMetadata>
    <RequestId>052dff47-5a11-48e6-82d1-77158ecf4cc9</RequestId>
  </ResponseMetadata>
</ModifyCustomDBEngineVersionResponse>
```

## See Also
<a name="API_ModifyCustomDBEngineVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyCustomDBEngineVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyCustomDBEngineVersion) 

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

Modifies 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?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_ModifyDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must match the identifier of an existing DB cluster.
Type: String  
Required: Yes

 ** AllocatedStorage **   
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Type: Integer  
Required: No

 ** AllowEngineModeChange **   
Specifies whether engine mode changes from `serverless` to `provisioned` are allowed.  
Valid for Cluster Type: Aurora Serverless v1 DB clusters only  
Constraints:  
+ You must allow engine mode changes when specifying a different value for the `EngineMode` parameter from the DB cluster's current engine mode.
Type: Boolean  
Required: No

 ** AllowMajorVersionUpgrade **   
Specifies whether major version upgrades are allowed.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ You must allow major version upgrades when specifying a value for the `EngineVersion` parameter that is a different major version than the DB cluster's current version.
Type: Boolean  
Required: No

 ** ApplyImmediately **   
Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.  
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.  
By default, this parameter is disabled.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AwsBackupRecoveryPointArn **   
The Amazon Resource Name (ARN) of the recovery point in AWS Backup.  
Type: String  
Length Constraints: Minimum length of 43. Maximum length of 350.  
Pattern: `arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\-]+:)?[a-z][a-z0-9\-]{0,255}`   
Required: No

 ** BacktrackWindow **   
The target backtrack window, in seconds. To disable backtracking, set this value to `0`.  
Valid for Cluster Type: Aurora MySQL DB clusters only  
Default: `0`   
Constraints:  
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Type: Long  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Specify a minimum value of `1`.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Default: `1`   
Constraints:  
+ Must be a value from 1 to 35.
Type: Integer  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB cluster's server certificate.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Multi-AZ DB clusters  
Type: String  
Required: No

 ** CloudwatchLogsExportConfiguration **   
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
The following values are valid for each DB engine:  
+ Aurora MySQL - `audit | error | general | instance | slowquery | iam-db-auth-error` 
+ Aurora PostgreSQL - `instance | postgresql | iam-db-auth-error` 
+ RDS for MySQL - `error | general | slowquery | iam-db-auth-error` 
+ RDS for PostgreSQL - `postgresql | upgrade | iam-db-auth-error` 
For more information about exporting CloudWatch Logs for Amazon RDS, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Type: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) object  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** DatabaseInsightsMode **   
Specifies the mode of Database Insights to enable for the DB cluster.  
If you change the value from `standard` to `advanced`, you must set the `PerformanceInsightsEnabled` parameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.  
If you change the value from `advanced` to `standard`, you can set the `PerformanceInsightsEnabled` parameter to `true` to collect detailed database counter and per-query metrics.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DBClusterInstanceClass **   
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines.  
For the full list of DB instance classes and availability for your engine, see [ DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Type: String  
Required: No

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to use for the DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DBInstanceParameterGroupName **   
The name of the DB parameter group to apply to all instances of the DB cluster.  
When you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only  
Default: The existing name setting  
Constraints:  
+ The DB parameter group must be in the same DB parameter group family as this DB cluster.
+ The `DBInstanceParameterGroupName` parameter is valid in combination with the `AllowMajorVersionUpgrade` parameter for a major version upgrade only.
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to move the DB cluster to. Specify `none` to remove the cluster from its current domain. The domain must be created prior to this operation.  
For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** EnableGlobalWriteForwarding **   
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.  
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.  
Valid for Cluster Type: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnableHttpEndpoint **   
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.  
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.  
For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.  
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, use the `EnableHttpEndpoint` and `DisableHttpEndpoint` operations.
Valid for Cluster Type: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide* or [IAM database authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EnableLimitlessDatabase **   
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.  
Valid for: Aurora DB clusters only  
This setting is no longer used. Instead use the `ClusterScalabilityType` setting when you create your Aurora Limitless Database DB cluster.
Type: Boolean  
Required: No

 ** EnableLocalWriteForwarding **   
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.  
Valid for: Aurora DB clusters only  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to turn on Performance Insights for the DB cluster.  
For more information, see [ Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EngineMode **   
The DB engine mode of the DB cluster, either `provisioned` or `serverless`.  
The DB engine mode can be modified only from `serverless` to `provisioned`.
For more information, see [ CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).  
Valid for Cluster Type: Aurora DB clusters only  
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless `ApplyImmediately` is enabled.  
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.  
To list all of the available engine versions for Aurora MySQL, use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for Aurora PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for MySQL, use the following command:  
 `aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`   
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.  
For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Constraints:  
+ Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Type: Integer  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
If the DB cluster doesn't manage the master user password with AWS Secrets Manager, you can turn on this management. In this case, you can't specify `MasterUserPassword`.  
If the DB cluster already manages the master user password with AWS Secrets Manager, and you specify that the master user password is not managed with AWS Secrets Manager, then you must specify `MasterUserPassword`. In this case, RDS deletes the secret and uses the new password for the master user specified by `MasterUserPassword`.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*   
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** MasterUserAuthenticationType **   
Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.  
You can specify one of the following values:  
+  `password` - Use standard database authentication with a password.
+  `iam-db-auth` - Use IAM database authentication for the master user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.  
Type: String  
Valid Values: `password | iam-db-auth`   
Required: No

 ** MasterUserPassword **   
The new password for the master database user.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must contain from 8 to 41 characters.
+ Can contain any printable ASCII character except "/", """, or "@".
+ Can't be specified if `ManageMasterUserPassword` is turned on.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if both of the following conditions are met:  
+ The DB cluster doesn't manage the master user password in AWS Secrets Manager.

  If the DB cluster already manages the master user password in AWS Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
+ You are turning on `ManageMasterUserPassword` to manage the master user password in AWS Secrets Manager.

  If you are turning on `ManageMasterUserPassword` and don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) in the *Amazon RDS User Guide.*   
If `MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.  
Valid for Cluster Type: Multi-AZ DB clusters only  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB cluster.  
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*   
Valid for Cluster Type: Aurora DB clusters only  
Valid Values: `IPV4 | DUAL`   
Type: String  
Required: No

 ** NewDBClusterIdentifier **   
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ The first character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster2`   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to associate the DB cluster with.  
DB clusters are associated with a default option group that can't be modified.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS issues an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the DB cluster accepts connections.  
Valid for Cluster Type: Aurora DB clusters only  
Valid Values: `1150-65535`   
Default: The same port as the original DB cluster.  
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To view the time blocks available, see [ Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide*.  
Constraints:  
+ Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
+ Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
+ Must be in Universal Coordinated Time (UTC).
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** RotateMasterUserPassword **   
Specifies whether to rotate the secret managed by AWS Secrets Manager for the master user password.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB cluster. The secret value contains the updated password.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*   
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ You must apply the change immediately when rotating the master user password.
Type: Boolean  
Required: No

 ** ScalingConfiguration **   
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in `serverless` DB engine mode.  
Valid for Cluster Type: Aurora DB clusters only  
Type: [ScalingConfiguration](API_ScalingConfiguration.md) object  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.  
For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** StorageType **   
The storage type to associate with the DB cluster.  
For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).  
When specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values:  
+ Aurora DB clusters - `aurora | aurora-iopt1` 
+ Multi-AZ DB clusters - `io1 | io2 | gp3` 
Default:  
+ Aurora DB clusters - `aurora` 
+ Multi-AZ DB clusters - `io1` 
Type: String  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of EC2 VPC security groups to associate with this DB cluster.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_ModifyDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
The user already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBSecurityGroupState **   
The state of the DB security group doesn't allow deletion.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupStateFault **   
The DB subnet group cannot be deleted because it's in use.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotAvailableFault **   
The `aurora-iopt1` storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBCluster_Examples"></a>

### Modifying an Aurora DB cluster
<a name="API_ModifyDBCluster_Example_1"></a>

This example illustrates one usage of ModifyDBCluster.

#### Sample Request
<a name="API_ModifyDBCluster_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBCluster
    &DBClusterIdentifier=sample-cluster3
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140725/us-west-2/rds/aws4_request
    &X-Amz-Date=20140725T161457Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=d6d1c65c2e94f5800ab411a3f7336625820b103713b6c063430900514e21d784
```

#### Sample Response
<a name="API_ModifyDBCluster_Example_1_Response"></a>

```
<ModifyDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBClusterResult>
    <DBCluster>
      <Engine>aurora5.6</Engine>
      <Status>available</Status>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <DBSubnetGroup>my-subgroup</DBSubnetGroup>
      <EngineVersion>5.6.10a</EngineVersion>
      <Endpoint>sample-cluster3.cluster-cefgqfx9y5fy.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterIdentifier>sample-cluster3</DBClusterIdentifier>
      <PreferredBackupWindow>07:06-07:36</PreferredBackupWindow>
      <PreferredMaintenanceWindow>tue:10:18-tue:10:48</PreferredMaintenanceWindow>
      <DBClusterMembers>
        <DBClusterMember>
          <IsClusterWriter>true</IsClusterWriter>
          <DBInstanceIdentifier>sample-cluster3-master</DBInstanceIdentifier>
        </DBClusterMember>
        <DBClusterMember>
          <IsClusterWriter>false</IsClusterWriter>
          <DBInstanceIdentifier>sample-cluster3-read1</DBInstanceIdentifier>
        </DBClusterMember>
      </DBClusterMembers>
      <AllocatedStorage>15</AllocatedStorage>
      <MasterUsername>awsuser</MasterUsername>
    </DBCluster>
  </ModifyDBClusterResult>
  <ResponseMetadata>
    <RequestId>d2cd0e2f-1416-11e4-9210-cf99df4125d0</RequestId>
  </ResponseMetadata>
</ModifyDBClusterResponse>
```

### Modifying a Multi-AZ DB cluster
<a name="API_ModifyDBCluster_Example_2"></a>

This example illustrates one usage of ModifyDBCluster.

#### Sample Request
<a name="API_ModifyDBCluster_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBCluster
    &DBClusterIdentifier=my-multi-az-cluster
    &DBClusterInstanceClass=db.m6gd.large
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20211026/us-west-2/rds/aws4_request
    &X-Amz-Date=20211027T000032Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=d6d1c65c2e94f5800ab411a3f7336625820b103713b6c063430900514e21d784
```

#### Sample Response
<a name="API_ModifyDBCluster_Example_2_Response"></a>

```
<ModifyDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> 
  <ModifyDBClusterResult> 
    <DBCluster> 
      <CrossAccountClone>false</CrossAccountClone> 
      <AllocatedStorage>100</AllocatedStorage> 
      <DatabaseName>mydb</DatabaseName> 
        <AssociatedRoles /> 
        <AvailabilityZones> 
          <AvailabilityZone>us-west-2a</AvailabilityZone> 
          <AvailabilityZone>us-west-2b</AvailabilityZone> 
          <AvailabilityZone>us-west-2c</AvailabilityZone> 
        </AvailabilityZones> 
        <ReadReplicaIdentifiers /> 
        <Iops>1000</Iops> 
        <PerformanceInsightsKMSKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</PerformanceInsightsKMSKeyId> 
        <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod> 
        <EngineVersion>8.0.26</EngineVersion> 
        <MasterUsername>admin</MasterUsername> 
        <DBClusterMembers> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-3</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>false</IsClusterWriter> 
          </DBClusterMember> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>false</IsClusterWriter> 
          </DBClusterMember> 
          <DBClusterMember> 
            <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier> 
            <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
            <PromotionTier>1</PromotionTier> 
            <IsClusterWriter>true</IsClusterWriter> 
          </DBClusterMember> 
        </DBClusterMembers> 
        <HttpEndpointEnabled>false</HttpEndpointEnabled> 
        <Port>3306</Port> 
        <MonitoringInterval>30</MonitoringInterval> 
        <BackupRetentionPeriod>2</BackupRetentionPeriod> 
        <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId> 
        <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier> 
        <DbClusterResourceId>cluster-TSW4QJNKY3P2DNDRR523BDGEIU</DbClusterResourceId> 
        <Status>available</Status> 
        <LatestRestorableTime>2021-10-26T23:55:00Z</LatestRestorableTime> 
        <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow> 
        <DeletionProtection>false</DeletionProtection> 
        <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint> 
        <EngineMode>provisioned</EngineMode> 
        <Engine>mysql</Engine> 
        <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint> 
        <PubliclyAccessible>true</PubliclyAccessible> 
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled> 
        <EarliestRestorableTime>2021-10-26T20:42:03.375Z</EarliestRestorableTime> 
        <ClusterCreateTime>2021-10-26T20:31:54.943Z</ClusterCreateTime> 
        <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled> 
        <MultiAZ>true</MultiAZ> 
        <DomainMemberships /> 
        <MonitoringRoleArn>arn:aws:iam::123456789012:role/enhance-monitoring-role</MonitoringRoleArn> 
        <StorageEncrypted>true</StorageEncrypted> 
        <DBSubnetGroup>mysubnet1</DBSubnetGroup> 
        <VpcSecurityGroups> 
          <VpcSecurityGroupMembership> 
            <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId> 
            <Status>active</Status> 
          </VpcSecurityGroupMembership> 
        </VpcSecurityGroups> 
        <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId> 
        <TagList /> 
        <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow> 
        <DBClusterParameterGroup>my-multi-az-cpg</DBClusterParameterGroup> 
        <StorageType>io1</StorageType> 
        <DBClusterInstanceClass>db.m6gd.large</DBClusterInstanceClass> 
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot> 
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
        <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn> 
      </DBCluster> 
  </ModifyDBClusterResult> 
  <ResponseMetadata> 
    <RequestId>69673d54-e48e-4ba4-9333-c5a6c1e7526a</RequestId> 
  </ResponseMetadata> 
</ModifyDBClusterResponse>
```

## See Also
<a name="API_ModifyDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBCluster) 

# ModifyDBClusterEndpoint
<a name="API_ModifyDBClusterEndpoint"></a>

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

**Note**  
This operation only applies to Aurora DB clusters.

## Request Parameters
<a name="API_ModifyDBClusterEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterEndpointIdentifier **   
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 ** EndpointType **   
The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.  
Type: String  
Required: No

 **ExcludedMembers.member.N**   
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.  
Type: Array of strings  
Required: No

 **StaticMembers.member.N**   
List of DB instance identifiers that are part of the custom endpoint group.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBClusterEndpoint_ResponseElements"></a>

The following elements are returned by the service.

 ** CustomEndpointType **   
The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.  
Type: String

 ** DBClusterEndpointArn **   
The Amazon Resource Name (ARN) for the endpoint.  
Type: String

 ** DBClusterEndpointIdentifier **   
The identifier associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** DBClusterEndpointResourceIdentifier **   
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.  
Type: String

 ** DBClusterIdentifier **   
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.  
Type: String

 ** Endpoint **   
The DNS address of the endpoint.  
Type: String

 ** EndpointType **   
The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.  
Type: String

 **ExcludedMembers.member.N**   
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.  
Type: Array of strings

 **StaticMembers.member.N**   
List of DB instance identifiers that are part of the custom endpoint group.  
Type: Array of strings

 ** Status **   
The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that can't be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database.  
Type: String

## Errors
<a name="API_ModifyDBClusterEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterEndpointNotFoundFault **   
The specified custom endpoint doesn't exist.  
HTTP Status Code: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBClusterEndpointStateFault **   
The requested operation can't be performed on the endpoint while the endpoint is in this state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyDBClusterEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBClusterEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBClusterEndpoint) 

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

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.

**Important**  
There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using `RebootDBCluster` operation. You can use the *Parameter Groups* option of the [Amazon RDS console](https://console.aws.amazon.com/rds/) or the `DescribeDBClusterParameters` operation to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_ModifyDBClusterParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to modify.  
Type: String  
Required: Yes

 **Parameters.Parameter.N**   
A list of parameters in the DB cluster parameter group to modify.  
Valid Values (for the application method): `immediate | pending-reboot`   
You can use the `immediate` value with dynamic parameters only. You can use the `pending-reboot` value for both dynamic and static parameters.  
When the application method is `immediate`, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is `pending-reboot`, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
Type: Array of [Parameter](API_Parameter.md) objects  
Required: Yes

## Response Elements
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group.  
Constraints:  
+ Must be 1 to 255 letters or numbers.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Type: String

## Errors
<a name="API_ModifyDBClusterParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBClusterParameterGroup_Examples"></a>

### Example
<a name="API_ModifyDBClusterParameterGroup_Example_1"></a>

This example illustrates one usage of ModifyDBClusterParameterGroup.

#### Sample Request
<a name="API_ModifyDBClusterParameterGroup_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBClusterParameterGroup
    &DBClusterParameterGroupName=sample-cluster-pg
    &Parameters.member.1.ApplyMethod=pending-reboot
    &Parameters.member.1.ParameterName=binlog_format
    &Parameters.member.1.ParameterValue=MIXED
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
    &X-Amz-Date=20160913T173245Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=cfb4f35de32455f77405636315dd431f2e236a1a997f94e0f6e00183d1f5156e
```

#### Sample Response
<a name="API_ModifyDBClusterParameterGroup_Example_1_Response"></a>

```
<ModifyDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBClusterParameterGroupResult>
    <DBClusterParameterGroupName>sample-cluster-pg</DBClusterParameterGroupName>
  </ModifyDBClusterParameterGroupResult>
  <ResponseMetadata>
    <RequestId>1534d6a1-79d8-11e6-9b94-838991bd50c6</RequestId>
  </ResponseMetadata>
</ModifyDBClusterParameterGroupResponse>
```

## See Also
<a name="API_ModifyDBClusterParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBClusterParameterGroup) 

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify `restore` as the `AttributeName` and use the `ValuesToAdd` parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value `all` to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts.

**Note**  
Don't 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 is public or private, use the [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) API operation. The accounts are returned as values for the `restore` attribute.

## Request Parameters
<a name="API_ModifyDBClusterSnapshotAttribute_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AttributeName **   
The name of the DB cluster snapshot attribute to modify.  
To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to `restore`.  
To view the list of attributes available to modify, use the [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) API operation.
Type: String  
Required: Yes

 ** DBClusterSnapshotIdentifier **   
The identifier for the DB cluster snapshot to modify the attributes for.  
Type: String  
Required: Yes

 **ValuesToAdd.AttributeValue.N**   
A list of DB cluster snapshot attributes to add to the attribute specified by `AttributeName`.  
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or `all` to make the manual DB cluster snapshot restorable by any AWS account. 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.  
Type: Array of strings  
Required: No

 **ValuesToRemove.AttributeValue.N**   
A list of DB cluster snapshot attributes to remove from the attribute specified by `AttributeName`.  
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or `all` to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify `all`, an AWS account whose account ID is explicitly added to the `restore` attribute can still copy or restore a manual DB cluster snapshot.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterSnapshotAttributesResult **   
Contains the results of a successful call to the `DescribeDBClusterSnapshotAttributes` API action.  
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the `ModifyDBClusterSnapshotAttribute` API action.  
Type: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) object

## Errors
<a name="API_ModifyDBClusterSnapshotAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** SharedSnapshotQuotaExceeded **   
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBClusterSnapshotAttribute_Examples"></a>

### Example
<a name="API_ModifyDBClusterSnapshotAttribute_Example_1"></a>

This example illustrates one usage of ModifyDBClusterSnapshotAttribute.

#### Sample Request
<a name="API_ModifyDBClusterSnapshotAttribute_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBClusterSnapshotAttribute
    &AttributeName=restore
    &DBClusterSnapshotIdentifier=manual-cluster-snapshot1
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &ValuesToAdd.member.1=123451234512
    &ValuesToAdd.member.2=123456789012
    &ValuesToRemove.member.1=all
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150922/us-west-2/rds/aws4_request
    &X-Amz-Date=20150922T220515Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=ef38f1ce3dab4e1dbf113d8d2a265c67d17ece1999ffd36be85714ed36dddbb3
```

#### Sample Response
<a name="API_ModifyDBClusterSnapshotAttribute_Example_1_Response"></a>

```
<ModifyDBClusterSnapshotAttributeResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBClusterSnapshotAttributeResult>
    <DBClusterSnapshotAttributesResult>
      <DBClusterSnapshotAttributes>
        <DBClusterSnapshotAttribute>
          <AttributeName>restore</AttributeName>
          <AttributeValues>
            <AttributeValue>123451234512</AttributeValue>
            <AttributeValue>123456789012</AttributeValue>
          </AttributeValues>
        </DBClusterSnapshotAttribute>
      </DBClusterSnapshotAttributes>
      <DBClusterSnapshotIdentifier>manual-cluster-snapshot1</DBSnapshotIdentifier>
    </DBClusterSnapshotAttributesResult>
  </ModifyDBClusterSnapshotAttributeResult>
  <ResponseMetadata>
    <RequestId>0122a108-2276-11e5-9cc3-0f535cff56aa</RequestId>
  </ResponseMetadata>
</ModifyDBClusterSnapshotAttributeResponse>
```

## See Also
<a name="API_ModifyDBClusterSnapshotAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBClusterSnapshotAttribute) 

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call `DescribeValidDBInstanceModifications` before you call `ModifyDBInstance`.

## Request Parameters
<a name="API_ModifyDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The identifier of DB instance to modify. This value is stored as a lowercase string.  
Constraints:  
+ Must match the identifier of an existing DB instance.
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to modify or delete for the DB instance. You can create up to 3 additional storage volumes. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [ModifyAdditionalStorageVolume](API_ModifyAdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.  
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.  
For the valid values for allocated storage for each engine, see `CreateDBInstance`.  
Constraints:  
+ When you increase the allocated storage for a DB instance that uses Provisioned IOPS (`gp3`, `io1`, or `io2` storage type), you must also specify the `Iops` parameter. You can use the current value for `Iops`.
Type: Integer  
Required: No

 ** AllowMajorVersionUpgrade **   
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.  
This setting doesn't apply to RDS Custom DB instances.  
Constraints:  
+ Major version upgrades must be allowed when specifying a value for the `EngineVersion` parameter that's a different major version than the DB instance's current version.
Type: Boolean  
Required: No

 ** ApplyImmediately **   
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the DB instance. By default, this parameter is disabled.  
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to [RebootDBInstance](API_RebootDBInstance.md), or the next failure reboot. Review the table of parameters in [Modifying a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) in the *Amazon RDS User Guide* to see the impact of enabling or disabling `ApplyImmediately` for each modified parameter and to determine when the changes are applied.  
Type: Boolean  
Required: No

 ** AutomationMode **   
The automation mode of the RDS Custom DB instance. If `full`, the DB instance automates monitoring and instance recovery. If `all paused`, the instance pauses automation for the duration set by `ResumeFullAutomationModeMinutes`.  
Type: String  
Valid Values: `full | all-paused`   
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:  
+ The automatic upgrade is enabled for the maintenance window.
+ A newer minor version is available.
+ RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.  
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AwsBackupRecoveryPointArn **   
The Amazon Resource Name (ARN) of the recovery point in AWS Backup.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Length Constraints: Minimum length of 43. Maximum length of 350.  
Pattern: `arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\-]+:)?[a-z][a-z0-9\-]{0,255}`   
Required: No

 ** BackupRetentionPeriod **   
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.  
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the `ApplyImmediately` parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.  
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Default: Uses existing setting  
Constraints:  
+ Must be a value from 0 to 35.
+ Can't be set to 0 if the DB instance is a source to read replicas.
+ Can't be set to 0 for an RDS Custom for Oracle DB instance.
Type: Integer  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB instance's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CertificateRotationRestart **   
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.  
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.  
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:  
+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [ Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* 
+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** CloudwatchLogsExportConfiguration **   
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.  
A change to the `CloudwatchLogsExportConfiguration` parameter is always applied to the DB instance immediately. Therefore, the `ApplyImmediately` parameter has no effect.  
This setting doesn't apply to RDS Custom DB instances.  
The following values are valid for each DB engine:  
+ Aurora MySQL - `audit | error | general | slowquery | iam-db-auth-error` 
+ Aurora PostgreSQL - `postgresql | iam-db-auth-error` 
+ RDS for MySQL - `error | general | slowquery | iam-db-auth-error` 
+ RDS for PostgreSQL - `postgresql | upgrade | iam-db-auth-error` 
For more information about exporting CloudWatch Logs for Amazon RDS, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Type: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) object  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.  
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see `ModifyDBCluster`.  
Type: Boolean  
Required: No

 ** DatabaseInsightsMode **   
Specifies the mode of Database Insights to enable for the DB instance.  
Aurora DB instances inherit this value from the DB cluster, so you can't change this value.
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DBInstanceClass **   
The new compute and memory capacity of the DB instance, for example `db.m4.large`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. For RDS Custom, see [DB instance class support for RDS Custom for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.instances) and [ DB instance class support for RDS Custom for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.instancesMS).  
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify `ApplyImmediately` in your request.   
Default: Uses existing setting  
Constraints:  
+ If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to apply to the DB instance.  
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.  
This setting doesn't apply to RDS Custom DB instances.  
Default: Uses existing setting  
Constraints:  
+ Must be in the same DB parameter group family as the DB instance.
Type: String  
Required: No

 ** DBPortNumber **   
The port number on which the database accepts connections.  
The value of the `DBPortNumber` parameter must not match any of the port values specified for options in the option group for the DB instance.  
If you change the `DBPortNumber` value, your database restarts regardless of the value of the `ApplyImmediately` parameter.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values: `1150-65535`   
Default:  
+ Amazon Aurora - `3306` 
+ RDS for Db2 - `50000` 
+ RDS for MariaDB - `3306` 
+ RDS for Microsoft SQL Server - `1433` 
+ RDS for MySQL - `3306` 
+ RDS for Oracle - `1521` 
+ RDS for PostgreSQL - `5432` 
Constraints:  
+ For RDS for Microsoft SQL Server, the value can't be `1234`, `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
Type: Integer  
Required: No

 **DBSecurityGroups.DBSecurityGroupName.N**   
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.  
This setting doesn't apply to RDS Custom DB instances.  
Constraints:  
+ If supplied, must match existing DB security groups.
Type: Array of strings  
Required: No

 ** DBSubnetGroupName **   
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC) in the *Amazon RDS User Guide*.  
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable `ApplyImmediately`.  
This setting doesn't apply to RDS Custom DB instances.  
Constraints:  
+ If supplied, must match existing DB subnet group.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DedicatedLogVolume **   
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see `ModifyDBCluster`. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.  
Type: Boolean  
Required: No

 ** DisableDomain **   
Specifies whether to remove the DB instance from the Active Directory domain.  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to move the DB instance to. Specify `none` to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainAuthSecretArn **   
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.  
Example: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`   
Type: String  
Required: No

 **DomainDnsIps.member.N**   
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.  
Constraints:  
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: `123.124.125.126,234.235.236.237`   
Type: Array of strings  
Required: No

 ** DomainFqdn **   
The fully qualified domain name (FQDN) of an Active Directory domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `mymanagedADtest.mymanagedAD.mydomain`   
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainOu **   
The Active Directory organizational unit for your DB instance to join.  
Constraints:  
+ Must be in the distinguished name format.
Example: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`   
Type: String  
Required: No

 ** EnableCustomerOwnedIp **   
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.  
A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.  
For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*.  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.  
For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*   
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to enable Performance Insights for the DB instance.  
For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** Engine **   
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.  
Note the following requirements:  
+ Make sure that you specify `oracle-ee-cdb` or `oracle-se2-cdb`.
+ Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:  
+ You can't convert a CDB to a non-CDB.
+ You can't convert a replica database.
+ You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
+ You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with `--db-parameter-group-name` and a new option group with `--option-group-name`.
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is enabled for this request.  
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.  
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.  
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.  
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.  
Constraints:  
+ If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
Type: String  
Required: No

 ** Iops **   
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.  
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.  
If you choose to migrate your DB instance from using standard storage to Provisioned IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.  
  
Constraints:  
+ For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
+ When you increase the Provisioned IOPS, you must also specify the `AllocatedStorage` parameter. You can use the current value for `AllocatedStorage`.
Default: Uses existing setting  
Type: Integer  
Required: No

 ** LicenseModel **   
The license model for the DB instance.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Valid Values:  
+ RDS for Db2 - `bring-your-own-license` 
+ RDS for MariaDB - `general-public-license` 
+ RDS for Microsoft SQL Server - `license-included` 
+ RDS for MySQL - `general-public-license` 
+ RDS for Oracle - `bring-your-own-license | license-included` 
+ RDS for PostgreSQL - `postgresql-license` 
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
If the DB instance doesn't manage the master user password with AWS Secrets Manager, you can turn on this management. In this case, you can't specify `MasterUserPassword`.  
If the DB instance already manages the master user password with AWS Secrets Manager, and you specify that the master user password is not managed with AWS Secrets Manager, then you must specify `MasterUserPassword`. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by `MasterUserPassword`.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
+ Can't specify for RDS for Oracle CDB instances in the multi-tenant configuration. Use `ModifyTenantDatabase` instead.
+ Can't specify the parameters `ManageMasterUserPassword` and `MultiTenant` in the same operation.
Type: Boolean  
Required: No

 ** MasterUserAuthenticationType **   
Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.  
You can specify one of the following values:  
+  `password` - Use standard database authentication with a password.
+  `iam-db-auth` - Use IAM database authentication for the master user.
This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.  
Type: String  
Valid Values: `password | iam-db-auth`   
Required: No

 ** MasterUserPassword **   
The new password for the master user.  
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the `MasterUserPassword` element exists in the `PendingModifiedValues` element of the operation response.  
Amazon RDS API operations never return the password, so this operation provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora

  The password for the master user is managed by the DB cluster. For more information, see `ModifyDBCluster`.
+ RDS Custom
+ RDS for Oracle CDBs in the multi-tenant configuration

  Specify the master password in `ModifyTenantDatabase` instead.
Default: Uses existing setting  
Constraints:  
+ Can't be specified if `ManageMasterUserPassword` is turned on.
+ Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:  
+ RDS for Db2 - Must contain from 8 to 255 characters.
+ RDS for MariaDB - Must contain from 8 to 41 characters.
+ RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
+ RDS for MySQL - Must contain from 8 to 41 characters.
+ RDS for Oracle - Must contain from 8 to 30 characters.
+ RDS for PostgreSQL - Must contain from 8 to 128 characters.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if both of the following conditions are met:  
+ The DB instance doesn't manage the master user password in AWS Secrets Manager.

  If the DB instance already manages the master user password in AWS Secrets Manager, you can't change the KMS key used to encrypt the secret.
+ You are turning on `ManageMasterUserPassword` to manage the master user password in AWS Secrets Manager.

  If you are turning on `ManageMasterUserPassword` and don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** MaxAllocatedStorage **   
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.  
For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Integer  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a value other than `0`.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) in the *Amazon RDS User Guide.*   
If `MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** MultiAZ **   
Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the `ApplyImmediately` parameter is enabled for this request.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 ** MultiTenant **   
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.  
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name, character set, and national character set metadata with this database. The tags associated with the instance also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the `CreateTenantDatabase` operation.  
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back to the single-tenant configuration. When you specify this parameter, you must also specify `ApplyImmediately`.
Type: Boolean  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Valid Values: `IPV4 | DUAL`   
Type: String  
Required: No

 ** NewDBInstanceIdentifier **   
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable `ApplyImmediately`, or will occur during the next maintenance window if you disable `ApplyImmediately`. This value is stored as a lowercase string.  
This setting doesn't apply to RDS Custom DB instances.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ The first character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `mydbinstance`   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to associate the DB instance with.  
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.  
The change is applied during the next maintenance window unless the `ApplyImmediately` parameter is enabled for this request.  
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
This setting doesn't apply to RDS Custom DB instances.  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS returns an error.  
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information, see [Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.  
For more information, see [Amazon RDS Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) in the *Amazon RDS User Guide.*   
Default: Uses existing setting  
Constraints:  
+ Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
+ The day values must be `mon | tue | wed | thu | fri | sat | sun`. 
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred backup window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PromotionTier **   
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [ Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.  
This setting doesn't apply to RDS Custom DB instances.  
Default: `1`   
Valid Values: `0 - 15`   
Type: Integer  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
 `PubliclyAccessible` only applies to DB instances in a VPC. The DB instance must be part of a public subnet and `PubliclyAccessible` must be enabled for it to be publicly accessible.  
Changes to the `PubliclyAccessible` parameter are applied immediately regardless of the value of the `ApplyImmediately` parameter.  
Type: Boolean  
Required: No

 ** ReplicaMode **   
The open mode of a replica database.  
This parameter is only supported for Db2 DB instances and Oracle DB instances.    
 **Db2**   
Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read-only workload.  
You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see [Working with replicas for Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html) in the *Amazon RDS User Guide*.  
To create standby DB replicas for RDS for Db2, set this parameter to `mounted`.  
 **Oracle**   
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.  
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see [Working with read replicas for Amazon RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.  
For RDS Custom, you must specify this parameter and set it to `mounted`. The value won't be set by default. After replica creation, you can manage the open mode manually.
Type: String  
Valid Values: `open-read-only | mounted`   
Required: No

 ** ResumeFullAutomationModeMinutes **   
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.  
Default: `60`   
Constraints:  
+ Must be at least 60.
+ Must be no more than 1,440.
Type: Integer  
Required: No

 ** RotateMasterUserPassword **   
Specifies whether to rotate the secret managed by AWS Secrets Manager for the master user password.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance. The secret value contains the updated password.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ You must apply the change immediately when rotating the master user password.
Type: Boolean  
Required: No

 ** StorageThroughput **   
The storage throughput value for the DB instance.  
This setting applies only to the `gp3` storage type.  
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Type: Integer  
Required: No

 ** StorageType **   
The storage type to associate with the DB instance.  
If you specify `io1`, `io2`, or `gp3` you must also include a value for the `Iops` parameter.  
If you choose to migrate your DB instance from using standard storage to gp2 (General Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
Default: `io1`, if the `Iops` parameter is specified. Otherwise, `gp2`.  
Type: String  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** TdeCredentialArn **   
The ARN from the key store with which to associate the instance for TDE encryption.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** TdeCredentialPassword **   
The password for the given ARN from the key store in order to access the device.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** UseDefaultProcessorFeatures **   
Specifies whether the DB instance class of the DB instance uses its default processor features.  
This setting doesn't apply to RDS Custom DB instances.  
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.  
This setting doesn't apply to the following DB instances:  
+ Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see `ModifyDBCluster`.)
+ RDS Custom
Constraints:  
+ If supplied, must match existing VPC security group IDs.
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_ModifyDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** BackupPolicyNotFoundFault **   
 *This error has been deprecated.*   
  
HTTP Status Code: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBUpgradeDependencyFailure **   
The DB upgrade failed because a resource the DB depends on can't be modified.  
HTTP Status Code: 400

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBSecurityGroupState **   
The state of the DB security group doesn't allow deletion.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBInstance_Examples"></a>

### Example
<a name="API_ModifyDBInstance_Example_1"></a>

This example illustrates one usage of ModifyDBInstance.

#### Sample Request
<a name="API_ModifyDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ModifyDBInstance
   &AllocatedStorage=20
   &DBInstanceIdentifier=myawsuser-dbi04
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T192732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=1dc9dd716f4855e9bdf188c70f1cf9f6251b070b68b81103b59ec70c3e7854b3
```

#### Sample Response
<a name="API_ModifyDBInstance_Example_1_Response"></a>

```
<ModifyDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBInstanceResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DBInstanceStatus>available</DBInstanceStatus>
      <MultiAZ>true</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>myawsuser-dbi04</DBInstanceIdentifier>
      <PreferredBackupWindow>10:03-10:33</PreferredBackupWindow>
      <PreferredMaintenanceWindow>wed:03:32-wed:04:02</PreferredMaintenanceWindow>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <ReadReplicaDBInstanceIdentifiers/>
      <LatestRestorableTime>2014-04-25T19:25:00Z</LatestRestorableTime>
      <Engine>mysql</Engine>
      <PendingModifiedValues>
        <AllocatedStorage>20</AllocatedStorage>
      </PendingModifiedValues>
      <LicenseModel>general-public-license</LicenseModel>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <Endpoint>
        <Port>3306</Port>
        <Address>myawsuser-dbi04.cg037hpkuyjt.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <EngineVersion>5.6.13</EngineVersion>
      <SecondaryAvailabilityZone>us-east-1b</SecondaryAvailabilityZone>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>myawsuser_db04</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <InstanceCreateTime>2014-04-25T18:07:51.508Z</InstanceCreateTime>
      <AllocatedStorage>15</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.small</DBInstanceClass>
    </DBInstance>
  </ModifyDBInstanceResult>
  <ResponseMetadata>
    <RequestId>f643f1ac-bbfe-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</ModifyDBInstanceResponse>
```

## See Also
<a name="API_ModifyDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBInstance) 

# ModifyDBParameterGroup
<a name="API_ModifyDBParameterGroup"></a>

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.

**Important**  
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 operation 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](https://console.aws.amazon.com/rds/) or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified.

## Request Parameters
<a name="API_ModifyDBParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Constraints:  
+ If supplied, must match the name of an existing `DBParameterGroup`.
Type: String  
Required: Yes

 **Parameters.Parameter.N**   
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.  
Valid Values (for the application method): `immediate | pending-reboot`   
You can use the `immediate` value with dynamic parameters only. You can use the `pending-reboot` value for both dynamic and static parameters.  
When the application method is `immediate`, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.  
When the application method is `pending-reboot`, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.  
You can't use `pending-reboot` with dynamic parameters on RDS for SQL Server DB instances. Use `immediate`.
For more information on modifying DB parameters, see [Working with DB parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: Yes

## Response Elements
<a name="API_ModifyDBParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Type: String

## Errors
<a name="API_ModifyDBParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBParameterGroup_Examples"></a>

### Example
<a name="API_ModifyDBParameterGroup_Example_1"></a>

This example illustrates one usage of ModifyDBParameterGroup.

#### Sample Request
<a name="API_ModifyDBParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ModifyDBParameterGroup
   &DBParameterGroupName=mydbparametergroup01
   &Parameters.member.1.ApplyMethod=immediate
   &Parameters.member.1.ParameterName=binlog_cache_size
   &Parameters.member.1.ParameterValue=65536
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T193811Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=afd9acfee876360dd294189465aca26502343d405292dc6e43b1961ad4d1d7e2
```

#### Sample Response
<a name="API_ModifyDBParameterGroup_Example_1_Response"></a>

```
<ModifyDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBParameterGroupResult>
    <DBParameterGroupName>mydbparametergroup01</DBParameterGroupName>
  </ModifyDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>12d7435e-bba0-11d3-fe11-33d33a9bb7e3</RequestId>
  </ResponseMetadata>
</ModifyDBParameterGroupResponse>
```

## See Also
<a name="API_ModifyDBParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBParameterGroup) 

# ModifyDBProxy
<a name="API_ModifyDBProxy"></a>

Changes the settings for an existing DB proxy.

## Request Parameters
<a name="API_ModifyDBProxy_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier for the `DBProxy` to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **Auth.member.N**   
The new authentication settings for the `DBProxy`.  
Type: Array of [UserAuthConfig](API_UserAuthConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** DebugLogging **   
Specifies whether the proxy logs detailed connection and query information. When you enable `DebugLogging`, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.  
Type: Boolean  
Required: No

 ** DefaultAuthScheme **   
The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are `NONE` and `IAM_AUTH`. When set to `IAM_AUTH`, the proxy uses end-to-end IAM authentication to connect to the database.  
Type: String  
Valid Values: `IAM_AUTH | NONE`   
Required: No

 ** IdleClientTimeout **   
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.  
Type: Integer  
Required: No

 ** NewDBProxyName **   
The new identifier for the `DBProxy`. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 ** RequireTLS **   
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.  
Type: Boolean  
Required: No

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 **SecurityGroups.member.N**   
The new list of security groups for the `DBProxy`.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBProxy_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxy **   
The `DBProxy` object representing the new settings for the proxy.  
Type: [DBProxy](API_DBProxy.md) object

## Errors
<a name="API_ModifyDBProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyAlreadyExistsFault **   
The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyDBProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBProxy) 

# ModifyDBProxyEndpoint
<a name="API_ModifyDBProxyEndpoint"></a>

Changes the settings for an existing DB proxy endpoint.

## Request Parameters
<a name="API_ModifyDBProxyEndpoint_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyEndpointName **   
The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** NewDBProxyEndpointName **   
The new identifier for the `DBProxyEndpoint`. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

 **VpcSecurityGroupIds.member.N**   
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBProxyEndpoint_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxyEndpoint **   
The `DBProxyEndpoint` object representing the new settings for the DB proxy endpoint.  
Type: [DBProxyEndpoint](API_DBProxyEndpoint.md) object

## Errors
<a name="API_ModifyDBProxyEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyEndpointAlreadyExistsFault **   
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** InvalidDBProxyEndpointStateFault **   
You can't perform this operation while the DB proxy endpoint is in a particular state.  
HTTP Status Code: 400

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyDBProxyEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBProxyEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBProxyEndpoint) 

# ModifyDBProxyTargetGroup
<a name="API_ModifyDBProxyTargetGroup"></a>

Modifies the properties of a `DBProxyTargetGroup`.

## Request Parameters
<a name="API_ModifyDBProxyTargetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The name of the proxy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** TargetGroupName **   
The name of the target group to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** ConnectionPoolConfig **   
The settings that determine the size and behavior of the connection pool for the target group.  
Type: [ConnectionPoolConfiguration](API_ConnectionPoolConfiguration.md) object  
Required: No

 ** NewName **   
The new name for the modified `DBProxyTarget`. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.  
You can't rename the `default` target group.  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyDBProxyTargetGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBProxyTargetGroup **   
The settings of the modified `DBProxyTarget`.  
Type: [DBProxyTargetGroup](API_DBProxyTargetGroup.md) object

## Errors
<a name="API_ModifyDBProxyTargetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyDBProxyTargetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBProxyTargetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBProxyTargetGroup) 

# ModifyDBRecommendation
<a name="API_ModifyDBRecommendation"></a>

Updates the recommendation status and recommended action status for the specified recommendation.

## Request Parameters
<a name="API_ModifyDBRecommendation_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** RecommendationId **   
The identifier of the recommendation to update.  
Type: String  
Required: Yes

 ** Locale **   
The language of the modified recommendation.  
Type: String  
Required: No

 **RecommendedActionUpdates.member.N**   
The list of recommended action status to update. You can update multiple recommended actions at one time.  
Type: Array of [RecommendedActionUpdate](API_RecommendedActionUpdate.md) objects  
Required: No

 ** Status **   
The recommendation status to update.  
Valid values:  
+ active
+ dismissed
Type: String  
Required: No

## Response Elements
<a name="API_ModifyDBRecommendation_ResponseElements"></a>

The following element is returned by the service.

 ** DBRecommendation **   
The recommendation for your DB instances, DB clusters, and DB parameter groups.  
Type: [DBRecommendation](API_DBRecommendation.md) object

## Errors
<a name="API_ModifyDBRecommendation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ModifyDBRecommendation_Examples"></a>

### Modifying the recommended action status for a recommendation
<a name="API_ModifyDBRecommendation_Example_1"></a>

This example illustrates one usage of ModifyDBRecommendation.

#### Sample Request
<a name="API_ModifyDBRecommendation_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=ModifyDBRecommendation
    &RecommendationId=15e811d7-ec23-4d94-8d28-74cd2e7729ad
    &RecommendedActionUpdates.member.1.ActionId=806effbdc8853c4bf0e794c0c240ee8e
    &RecommendedActionUpdates.member.1.Status=applied
    &Locale=es
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230222/us-east-1/rds/aws4_request
    &X-Amz-Date=20230222T200807Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_ModifyDBRecommendation_Example_1_Response"></a>

```
<ModifyDBRecommendationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBRecommendationResult>
    <DBRecommendation>
      <RecommendationId>15e811d7-ec23-4d94-8d28-74cd2e7729ad</RecommendationId>
      <TypeId>config_recommendation::multi_az_instance</TypeId>
      <Severity>low</Severity>
      <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
      <Status>pending</Status>
      <CreatedTime>2023-10-05T18:04:04.017000+00:00</CreatedTime>
      <UpdatedTime>2023-10-20T19:17:18+00:00</UpdatedTime>
      <Detection>**1 resource** is not a Multi-AZ instance</Detection>
      <Recommendation>Set up Multi-AZ for the impacted DB instances</Recommendation>
      <Description>We recommend that you use Multi-AZ deployment. The Multi-AZ deployments enhance the availability and durability of the DB instance. Click Info for more details about Multi-AZ deployment and pricing.</Description>
      <RecommendedActions>
        <member>
          <ActionId>806effbdc8853c4bf0e794c0c240ee8e</ActionId>
          <Operation>modifyDbInstance</Operation>
          <Parameters>
            <member>
              <Key>MultiAZ</Key>
              <Value>true</Value>
            </member>
            <member>
              <Key>DBInstanceIdentifier</Key>
              <Value>mariadb-instance</Value>
            </member>
          </Parameters>
          <ApplyModes>
            <member>immediately</member>
            <member>next-maintenance-window</member>
          </ApplyModes>
          <Status>applied</Status>
          <ContextAttributes>
            <member>
              <Key>resourceArn</Key>
              <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
            </member>
            <member>
              <Key>engineName</Key>
              <Value>mariadb</Value>
            </member>
          </ContextAttributes>
        </member>
      </RecommendedActions>
      <Category>reliability</Category>
      <Source>RDS</Source>
      <TypeDetection>**[resource-count] resources** are not Multi-AZ instances</TypeDetection>
      <TypeRecommendation>Set up Multi-AZ for the impacted DB instances</TypeRecommendation>
      <Impact>Data availability at risk</Impact>
      <AdditionalInfo>In an Amazon RDS Multi-AZ deployment, Amazon RDS automatically creates a primary database instance and replicates the data to an instance in a different availability zone. When it detects a failure, Amazon RDS automatically fails over to a standby instance without manual intervention.</AdditionalInfo>
      <Links>
        <member>
          <Text>Pricing for Amazon RDS Multi-AZ</Text>
          <Url>https://aws.amazon.com/rds/features/multi-az/#Pricing</Url>
        </member>
      </Links>
    </DBRecommendation>
  </ModifyDBRecommendationResult>
</ModifyDBRecommendationResponse>
```

### Modifying the recommendation status for the specified recommendation ID
<a name="API_ModifyDBRecommendation_Example_2"></a>

This example illustrates one usage of ModifyDBRecommendation.

#### Sample Request
<a name="API_ModifyDBRecommendation_Example_2_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=ModifyDBRecommendation
    &RecommendationId=8c9132b0-267d-4493-b3c4-aedd0920809d
    &Status=dismissed
    &Locale=es
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230222/us-east-1/rds/aws4_request
    &X-Amz-Date=20230222T200807Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b
```

#### Sample Response
<a name="API_ModifyDBRecommendation_Example_2_Response"></a>

```
<ModifyDBRecommendationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBRecommendationResult>
    <DBRecommendation>
      <RecommendationId>8c9132b0-267d-4493-b3c4-aedd0920809d</RecommendationId>
      <TypeId>config_recommendation::enhanced_monitoring_off</TypeId>
      <Severity>low</Severity>
      <ResourceArn>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</ResourceArn>
      <Status>dismissed</Status>
      <CreatedTime>2023-10-05T18:04:03.957000+00:00</CreatedTime>
      <UpdatedTime>2023-10-20T19:20:22+00:00</UpdatedTime>
      <Detection>**1 resource** doesn't have Enhanced Monitoring enabled</Detection>
      <Recommendation>Turn on Enhanced Monitoring</Recommendation>
      <Description>Your database resources don't have Enhanced Monitoring turned on. Enhanced Monitoring provides real-time operating system metrics for monitoring and troubleshooting.</Description>
      <RecommendedActions>
        <member>
          <ActionId>a2e5e55f28854f9ec12f45c227d85f48</ActionId>
          <Operation>modifyDbInstance</Operation>
          <Parameters>
            <member>
              <Key>MonitoringInterval</Key>
              <Value>60</Value>
            </member>
            <member>
              <Key>DBInstanceIdentifier</Key>
              <Value>mariadb-instance</Value>
            </member>
          </Parameters>
          <ApplyModes>
            <mmeber>immediately</mmeber>
          </ApplyModes>
          <Status>ready</Status>
          <ContextAttributes>
            <member>
              <Key>resourceArn</Key>
              <Value>arn:aws:rds:us-west-2:636812126935:db:mariadb-instance</Value>
            </member>
            <member>
              <Key>engineName</Key>
              <Value>mariadb</Value>
            </member>
            <member>
              <Key>recommendedValue</Key>
              <Value>60</Value>
            </member>
          </ContextAttributes>
        </member>
      </RecommendedActions>
      <Category>reliability</Category>
      <Source>RDS</Source>
      <TypeDetection>**[resource-count] resources** don't have Enhanced Monitoring enabled</TypeDetection>
      <TypeRecommendation>Turn on Enhanced Monitoring</TypeRecommendation>
      <Impact>Reduced operational visibility</Impact>
      <AdditionalInfo>Enhanced Monitoring for Amazon RDS provides additional visibility on the health of your DB instances. We recommend that you turn on Enhanced Monitoring. When the Enhanced Monitoring option is turned on for your DB instance, it collects vital operating system metrics and process information.</AdditionalInfo>
      <Links>
        <member>
          <Text>Turning Enhanced Monitoring on and off</Text>
          <Url>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html</Url>
        </member>
      </Links>
    </DBRecommendation>
  </ModifyDBRecommendationResult>
</ModifyDBRecommendationResponse>
```

## See Also
<a name="API_ModifyDBRecommendation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBRecommendation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBRecommendation) 

# ModifyDBShardGroup
<a name="API_ModifyDBShardGroup"></a>

Modifies 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.

## Request Parameters
<a name="API_ModifyDBShardGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBShardGroupIdentifier **   
The name of the DB shard group to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 ** ComputeRedundancy **   
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
+ 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
Type: Integer  
Required: No

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double  
Required: No

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double  
Required: No

## Response Elements
<a name="API_ModifyDBShardGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ComputeRedundancy **   
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
+ 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
Type: Integer

 ** DBClusterIdentifier **   
The name of the primary DB cluster for the DB shard group.  
Type: String

 ** DBShardGroupArn **   
The Amazon Resource Name (ARN) for the DB shard group.  
Type: String

 ** DBShardGroupIdentifier **   
The name of the DB shard group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** DBShardGroupResourceId **   
The AWS Region-unique, immutable identifier for the DB shard group.  
Type: String

 ** Endpoint **   
The connection endpoint for the DB shard group.  
Type: String

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** PubliclyAccessible **   
Indicates whether the DB shard group is publicly accessible.  
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.  
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBShardGroup](API_CreateDBShardGroup.md).  
This setting is only for Aurora Limitless Database.  
Type: Boolean

 ** Status **   
The status of the DB shard group.  
Type: String

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ModifyDBShardGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBShardGroupAlreadyExists **   
The specified DB shard group name must be unique in your AWS account in the specified AWS Region.  
HTTP Status Code: 400

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyDBShardGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBShardGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBShardGroup) 

# ModifyDBSnapshot
<a name="API_ModifyDBSnapshot"></a>

Updates 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.

## Request Parameters
<a name="API_ModifyDBSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSnapshotIdentifier **   
The identifier of the DB snapshot to modify.  
Type: String  
Required: Yes

 ** EngineVersion **   
The engine version to upgrade the DB snapshot to.  
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.  
 **MariaDB**   
For the list of engine versions that are available for upgrading a DB snapshot, see [ Upgrading a MariaDB DB snapshot engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mariadb-upgrade-snapshot.html) in the *Amazon RDS User Guide.*   
 **MySQL**   
For the list of engine versions that are available for upgrading a DB snapshot, see [ Upgrading a MySQL DB snapshot engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html) in the *Amazon RDS User Guide.*   
 **Oracle**   
+  `21.0.0.0.ru-2025-04.rur-2025-04.r1` (supported for 21.0.0.0.ru-2022-01.rur-2022-01.r1, 21.0.0.0.ru-2022-04.rur-2022-04.r1, 21.0.0.0.ru-2022-07.rur-2022-07.r1, 21.0.0.0.ru-2022-10.rur-2022-10.r1, 21.0.0.0.ru-2023-01.rur-2023-01.r1 and 21.0.0.0.ru-2023-01.rur-2023-01.r2 DB snapshots)
+  `19.0.0.0.ru-2025-04.rur-2025-04.r1` (supported for 19.0.0.0.ru-2019-07.rur-2019-07.r1, 19.0.0.0.ru-2019-10.rur-2019-10.r1 and 0.0.0.ru-2020-01.rur-2020-01.r1 DB snapshots)
+  `19.0.0.0.ru-2022-01.rur-2022-01.r1` (supported for 12.2.0.1 DB snapshots)
+  `19.0.0.0.ru-2022-07.rur-2022-07.r1` (supported for 12.1.0.2 DB snapshots)
+  `12.1.0.2.v8` (supported for 12.1.0.1 DB snapshots)
+  `11.2.0.4.v12` (supported for 11.2.0.2 DB snapshots)
+  `11.2.0.4.v11` (supported for 11.2.0.3 DB snapshots)
 **PostgreSQL**   
For the list of engine versions that are available for upgrading a DB snapshot, see [ Upgrading a PostgreSQL DB snapshot engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html) in the *Amazon RDS User Guide.*   
Type: String  
Required: No

 ** OptionGroupName **   
The option group to identify with the upgraded DB snapshot.  
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see [Option group considerations](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG) in the *Amazon RDS User Guide.*   
Type: String  
Required: No

## Response Elements
<a name="API_ModifyDBSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshot **   
Contains the details of an Amazon RDS DB snapshot.  
This data type is used as a response element in the `DescribeDBSnapshots` action.  
Type: [DBSnapshot](API_DBSnapshot.md) object

## Errors
<a name="API_ModifyDBSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBSnapshot_Examples"></a>

### Example
<a name="API_ModifyDBSnapshot_Example_1"></a>

This example illustrates one usage of ModifyDBSnapshot.

#### Sample Request
<a name="API_ModifyDBSnapshot_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBSnapshot
    &DBSnapshotIdentifier=mysnapshot1
    &EngineVersion=5.6.44
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20161228/us-west-2/rds/aws4_request
    &X-Amz-Date=20210628T220515Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=eb44f1ce3dab4e1dbf113d8d2a265d88d17ece1999ffd36be85714ed36cbdbe3
```

#### Sample Response
<a name="API_ModifyDBSnapshot_Example_1_Response"></a>

```
<ModifyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>available</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.44</EngineVersion>
      <DBInstanceIdentifier>mysqldb-sample</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysnapshot1</DBSnapshotIdentifier>
      <SnapshotCreateTime>2021-04-20T10:09:15.446Z</SnapshotCreateTime>
      <OriginalSnapshotCreateTime>2021-04-20T10:09:15.446Z</OriginalSnapshotCreateTime>
      <AvailabilityZone>us-west-2b</AvailabilityZone>
      <InstanceCreateTime>2016-12-28T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </ModifyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>aa80a25a-af09-11d4-ed11-23c32f9aa7d3</RequestId>
  </ResponseMetadata>
</ModifyDBSnapshotResponse>
```

## See Also
<a name="API_ModifyDBSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBSnapshot) 

# ModifyDBSnapshotAttribute
<a name="API_ModifyDBSnapshotAttribute"></a>

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify `restore` as the `AttributeName` and use the `ValuesToAdd` parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value `all` to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts.

**Note**  
Don't 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_DescribeDBSnapshotAttributes.md) API operation. The accounts are returned as values for the `restore` attribute.

## Request Parameters
<a name="API_ModifyDBSnapshotAttribute_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AttributeName **   
The name of the DB snapshot attribute to modify.  
To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to `restore`.  
To view the list of attributes available to modify, use the [DescribeDBSnapshotAttributes](API_DescribeDBSnapshotAttributes.md) API operation.
Type: String  
Required: Yes

 ** DBSnapshotIdentifier **   
The identifier for the DB snapshot to modify the attributes for.  
Type: String  
Required: Yes

 **ValuesToAdd.AttributeValue.N**   
A list of DB snapshot attributes to add to the attribute specified by `AttributeName`.  
To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or `all` to make the manual DB snapshot restorable by any AWS account. 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.  
Type: Array of strings  
Required: No

 **ValuesToRemove.AttributeValue.N**   
A list of DB snapshot attributes to remove from the attribute specified by `AttributeName`.  
To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or `all` to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify `all`, an AWS account whose account ID is explicitly added to the `restore` attribute can still copy or restore the manual DB snapshot.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyDBSnapshotAttribute_ResponseElements"></a>

The following element is returned by the service.

 ** DBSnapshotAttributesResult **   
Contains the results of a successful call to the `DescribeDBSnapshotAttributes` API action.  
Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the `ModifyDBSnapshotAttribute` API action.  
Type: [DBSnapshotAttributesResult](API_DBSnapshotAttributesResult.md) object

## Errors
<a name="API_ModifyDBSnapshotAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** SharedSnapshotQuotaExceeded **   
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBSnapshotAttribute_Examples"></a>

### Example
<a name="API_ModifyDBSnapshotAttribute_Example_1"></a>

This example illustrates one usage of ModifyDBSnapshotAttribute.

#### Sample Request
<a name="API_ModifyDBSnapshotAttribute_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBSnapshotAttribute
    &AttributeName=restore
    &DBSnapshotIdentifier=manual-snapshot1
    &SignatureMethod=HmacSHA256&SignatureVersion=4
    &ValuesToAdd.member.1=123451234512
    &ValuesToAdd.member.2=123456789012
    &ValuesToRemove.member.1=all
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20150922/us-west-2/rds/aws4_request
    &X-Amz-Date=20150922T220515Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=ef38f1ce3dab4e1dbf113d8d2a265c67d17ece1999ffd36be85714ed36dddbb3
```

#### Sample Response
<a name="API_ModifyDBSnapshotAttribute_Example_1_Response"></a>

```
<ModifyDBSnapshotAttributeResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBSnapshotAttributeResult>
    <DBSnapshotAttributesResult>
      <DBSnapshotAttributes>
        <DBSnapshotAttribute>
          <AttributeName>restore</AttributeName>
          <AttributeValues>
            <AttributeValue>123451234512</AttributeValue>
            <AttributeValue>123456789012</AttributeValue>
          </AttributeValues>
        </DBSnapshotAttribute>
      </DBSnapshotAttributes>
      <DBSnapshotIdentifier>manual-snapshot1</DBSnapshotIdentifier>
    </DBSnapshotAttributesResult>
  </ModifyDBSnapshotAttributeResult>
  <ResponseMetadata>
    <RequestId>0122a108-2276-11e5-9cc3-0f535cff56aa</RequestId>
  </ResponseMetadata>
</ModifyDBSnapshotAttributeResponse>
```

## See Also
<a name="API_ModifyDBSnapshotAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBSnapshotAttribute) 

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

## Request Parameters
<a name="API_ModifyDBSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSubnetGroupName **   
The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.  
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.  
Example: `mydbsubnetgroup`   
Type: String  
Required: Yes

 **SubnetIds.SubnetIdentifier.N**   
The EC2 subnet IDs for the DB subnet group.  
Type: Array of strings  
Required: Yes

 ** DBSubnetGroupDescription **   
The description for the DB subnet group.  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBSubnetGroup **   
Contains the details of an Amazon RDS DB subnet group.  
This data type is used as a response element in the `DescribeDBSubnetGroups` action.  
Type: [DBSubnetGroup](API_DBSubnetGroup.md) object

## Errors
<a name="API_ModifyDBSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DBSubnetQuotaExceededFault **   
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupStateFault **   
The DB subnet group cannot be deleted because it's in use.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** SubnetAlreadyInUse **   
The DB subnet is already in use in the Availability Zone.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDBSubnetGroup_Examples"></a>

### Example
<a name="API_ModifyDBSubnetGroup_Example_1"></a>

This example illustrates one usage of ModifyDBSubnetGroup.

#### Sample Request
<a name="API_ModifyDBSubnetGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ModifyDBSubnetGroup
   &DBSubnetGroupDescription=A%20new%20Description
   &DBSubnetGroupName=myawsuser-sngrp
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SubnetIds.member.1=subnet-e4d398a1
   &SubnetIds.member.2=subnet-c2bdb6ba
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
   &X-Amz-Date=20140425T200214Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=213c429d925cb1608fc13a1dde48715bcac3b0794536ee90beac34203265f9af
```

#### Sample Response
<a name="API_ModifyDBSubnetGroup_Example_1_Response"></a>

```
<ModifyDBSubnetGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBSubnetGroupResult>
    <DBSubnetGroup>
      <VpcId>vpc-33ac97ea</VpcId>
      <SubnetGroupStatus>Complete</SubnetGroupStatus>
      <DBSubnetGroupDescription>A new Description</DBSubnetGroupDescription>
      <DBSubnetGroupName>myawsuser-sngrp</DBSubnetGroupName>
      <Subnets>
        <Subnet>
          <SubnetStatus>Active</SubnetStatus>
          <SubnetIdentifier>subnet-e4d398a1</SubnetIdentifier>
          <SubnetAvailabilityZone>
            <Name>us-east-1b</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
          </SubnetAvailabilityZone>
        </Subnet>
        <Subnet>
          <SubnetStatus>Active</SubnetStatus>
          <SubnetIdentifier>subnet-c2bdb6ba</SubnetIdentifier>
          <SubnetAvailabilityZone>
            <Name>us-east-1c</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
          </SubnetAvailabilityZone>
        </Subnet>
      </Subnets>
    </DBSubnetGroup>
  </ModifyDBSubnetGroupResult>
  <ResponseMetadata>
    <RequestId>6dd028be-bba3-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</ModifyDBSubnetGroupResponse>
```

## See Also
<a name="API_ModifyDBSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

Modifies 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 for a given source type (`SourceType`) in [Events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation.

## Request Parameters
<a name="API_ModifyEventSubscription_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SubscriptionName **   
The name of the RDS event notification subscription.  
Type: String  
Required: Yes

 ** Enabled **   
Specifies whether to activate the subscription.  
Type: Boolean  
Required: No

 **EventCategories.EventCategory.N**   
A list of event categories for a source type (`SourceType`) that you want to subscribe to. You can see a list of the categories for a given source type in [Events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation.  
Type: Array of strings  
Required: No

 ** SnsTopicArn **   
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.  
Type: String  
Required: No

 ** SourceType **   
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify `db-proxy`. If this value isn't specified, all events are returned.  
Valid Values:` db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment `   
Type: String  
Required: No

## Response Elements
<a name="API_ModifyEventSubscription_ResponseElements"></a>

The following element is returned by the service.

 ** EventSubscription **   
Contains the results of a successful invocation of the `DescribeEventSubscriptions` action.  
Type: [EventSubscription](API_EventSubscription.md) object

## Errors
<a name="API_ModifyEventSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
You have reached the maximum number of event subscriptions.  
HTTP Status Code: 400

 ** SNSInvalidTopic **   
SNS has responded that there is a problem with the SNS topic specified.  
HTTP Status Code: 400

 ** SNSNoAuthorization **   
You do not have permission to publish to the SNS topic ARN.  
HTTP Status Code: 400

 ** SNSTopicArnNotFound **   
The SNS topic ARN does not exist.  
HTTP Status Code: 404

 ** SubscriptionCategoryNotFound **   
The supplied category does not exist.  
HTTP Status Code: 404

 ** SubscriptionNotFound **   
The subscription name does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_ModifyEventSubscription_Examples"></a>

### Example
<a name="API_ModifyEventSubscription_Example_1"></a>

This example illustrates one usage of ModifyEventSubscription.

#### Sample Request
<a name="API_ModifyEventSubscription_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=ModifyEventSubscription
   &Enabled=true
   &EventCategories.member.1=creation
   &EventCategories.member.2=deletion
   &EventCategories.member.3=failover
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SnsTopicArn=arn%3Aaws%3Asns%3Aus-west-2%3A802#########%3Amy-rds-events
   &SourceIds.member.1=myexampledb&SourceType=db-instance
   &SubscriptionName=ES-myuser01
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-west-2/rds/aws4_request
   &X-Amz-Date=20140428T183020Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=3d85bdfaf13861e93a9528824d9876ed87e6e01aaf43a962ce6f2a39247cf33a
```

#### Sample Response
<a name="API_ModifyEventSubscription_Example_1_Response"></a>

```
<ModifyEventSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyEventSubscriptionResult>
    <EventSubscription>
      <CustomerAwsId>802#########</CustomerAwsId>
      <Enabled>true</Enabled>
      <SourceType>db-instance</SourceType>
      <Status>modifying</Status>
      <SourceIdsList>
        <SourceId>myexampledb</SourceId>
      </SourceIdsList>
      <SubscriptionCreationTime>2014-04-28 18:24:52.735</SubscriptionCreationTime>
      <EventCategoriesList>
        <EventCategory>creation</EventCategory>
        <EventCategory>deletion</EventCategory>
        <EventCategory>failover</EventCategory>
      </EventCategoriesList>
      <CustSubscriptionId>ES-myuser01</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-west-2:802#########:my-rds-events</SnsTopicArn>
    </EventSubscription>
  </ModifyEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>1798605b-be02-11d3-f73c-899ec2766c3b</RequestId>
  </ResponseMetadata>
</ModifyEventSubscriptionResponse>
```

## See Also
<a name="API_ModifyEventSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Modifies 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?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation only applies to Aurora global database clusters.

## Request Parameters
<a name="API_ModifyGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalClusterIdentifier **   
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing global database cluster.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** AllowMajorVersionUpgrade **   
Specifies whether to allow major version upgrades.  
Constraints: Must be enabled if you specify a value for the `EngineVersion` parameter that's a different major version than the global cluster's current version.  
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.  
Type: Boolean  
Required: No

 ** EngineVersion **   
The version number of the database engine to which you want to upgrade.   
To list all of the available engine versions for `aurora-mysql` (for MySQL-based Aurora global databases), use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'`   
To list all of the available engine versions for `aurora-postgresql` (for PostgreSQL-based Aurora global databases), use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'`   
Type: String  
Required: No

 ** NewGlobalClusterIdentifier **   
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ The first character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster2`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: No

## Response Elements
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_ModifyGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalClusterAlreadyExistsFault **   
The `GlobalClusterIdentifier` already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.  
HTTP Status Code: 400

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## See Also
<a name="API_ModifyGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyGlobalCluster) 

# ModifyIntegration
<a name="API_ModifyIntegration"></a>

Modifies a zero-ETL integration with Amazon Redshift.

## Request Parameters
<a name="API_ModifyIntegration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** IntegrationIdentifier **   
The unique identifier of the integration to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_:\-\/]+`   
Required: Yes

 ** DataFilter **   
A new data filter for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html) or [Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25600.  
Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*`   
Required: No

 ** Description **   
A new description for the integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** IntegrationName **   
A new name for the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

## Response Elements
<a name="API_ModifyIntegration_ResponseElements"></a>

The following elements are returned by the service.

 **AdditionalEncryptionContext** AdditionalEncryptionContext.entry.N.key (key)AdditionalEncryptionContext.entry.N.value (value)  
The encryption context for the integration. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the * AWS Key Management Service Developer Guide*.  
Type: String to string map

 ** CreateTime **   
The time when the integration was created, in Universal Coordinated Time (UTC).  
Type: Timestamp

 ** DataFilter **   
Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25600.  
Pattern: `[a-zA-Z0-9_ "\\\-$,*.:?+\/]*` 

 ** Description **   
A description of the integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 **Errors.IntegrationError.N**   
Any errors associated with the integration.  
Type: Array of [IntegrationError](API_IntegrationError.md) objects

 ** IntegrationArn **   
The ARN of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** IntegrationName **   
The name of the integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** KMSKeyId **   
The AWS Key Management System (AWS KMS) key identifier for the key used to to encrypt the integration.   
Type: String

 ** SourceArn **   
The Amazon Resource Name (ARN) of the database used as the source for replication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[a-z\-]*:rds(-[a-z]*)?:[a-z0-9\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** Status **   
The current status of the integration.  
Type: String  
Valid Values: `creating | active | modifying | failed | deleting | syncing | needs_attention` 

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

 ** TargetArn **   
The ARN of the Redshift data warehouse used as the target for replication.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

## Errors
<a name="API_ModifyIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** IntegrationConflictOperationFault **   
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.  
HTTP Status Code: 400

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

 ** InvalidIntegrationStateFault **   
The integration is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyIntegration_Examples"></a>

### Example
<a name="API_ModifyIntegration_Example_1"></a>

This example illustrates one usage of ModifyIntegration.

#### Sample Request
<a name="API_ModifyIntegration_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ModifyIntegration
   &IntegrationIdentifier=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
   &IntegrationName=my-renamed-integration
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T183020Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=3d85bdfaf13861e93a9528824d9876ed87e6e01aaf43a962ce6f2a39247cf33a
```

#### Sample Response
<a name="API_ModifyIntegration_Example_1_Response"></a>

```
<ModifyIntegrationResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <ModifyIntegrationResult>
        <SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:my-cluster</SourceArn>
        <IntegrationName>my-renamed-integration</IntegrationName>
        <IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</IntegrationArn>
        <TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</TargetArn>
        <Tags/>
        <DataFilter>include: *.*</DataFilter>
        <CreateTime>2023-12-28T17:20:20.629Z</CreateTime>
        <KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa</KMSKeyId>
        <Status>active</Status>
    </ModifyIntegrationResult>
    <ResponseMetadata>
        <RequestId>7581f213-c5a1-42a5-b2cd-e151a1e1c129</RequestId>
    </ResponseMetadata>
</ModifyIntegrationResponse>
```

## See Also
<a name="API_ModifyIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyIntegration) 

# ModifyOptionGroup
<a name="API_ModifyOptionGroup"></a>

Modifies an existing option group.

## Request Parameters
<a name="API_ModifyOptionGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** OptionGroupName **   
The name of the option group to be modified.  
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance  
Type: String  
Required: Yes

 ** ApplyImmediately **   
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.  
Type: Boolean  
Required: No

 **OptionsToInclude.OptionConfiguration.N**   
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.  
Type: Array of [OptionConfiguration](API_OptionConfiguration.md) objects  
Required: No

 **OptionsToRemove.member.N**   
Options in this list are removed from the option group.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyOptionGroup_ResponseElements"></a>

The following element is returned by the service.

 ** OptionGroup **   
  
Type: [OptionGroup](API_OptionGroup.md) object

## Errors
<a name="API_ModifyOptionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOptionGroupStateFault **   
The option group isn't in the *available* state.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_ModifyOptionGroup_Examples"></a>

### Example
<a name="API_ModifyOptionGroup_Example_1"></a>

This example illustrates one usage of ModifyOptionGroup.

#### Sample Request
<a name="API_ModifyOptionGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=ModifyOptionGroup
    &ApplyImmediately=true
    &OptionGroupName=myawsuser-og02
    &OptionsToInclude.member.1.DBSecurityGroupMemberships.member.1=default
    &OptionsToInclude.member.1.OptionName=MEMCACHED
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140501/us-east-1/rds/aws4_request
    &X-Amz-Date=20140501T230529Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=4b278baae6294738704a9948e355af0e9bd4fa0913d5b35b0a9a3c916925aced
```

#### Sample Response
<a name="API_ModifyOptionGroup_Example_1_Response"></a>

```
<ModifyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyOptionGroupResult>
    <OptionGroup>
      <OptionGroupName>myawsuser-og02</OptionGroupName>
      <MajorEngineVersion>5.6</MajorEngineVersion>
      <AllowsVpcAndNonVpcInstanceMemberships>false</AllowsVpcAndNonVpcInstanceMemberships>
      <EngineName>mysql</EngineName>
      <OptionGroupDescription>my second og</OptionGroupDescription>
      <Options>
        <Option>
          <Port>11211</Port>
          <OptionName>MEMCACHED</OptionName>
          <OptionDescription>Innodb Memcached for MySQL</OptionDescription>
          <Persistent>false</Persistent>
          <OptionSettings>
            <OptionSetting>
              <DataType>BOOLEAN</DataType>
              <IsModifiable>true</IsModifiable>
              <IsCollection>false</IsCollection>
              <Description>If enabled when there is no more memory to store items, memcached will return an error rather than evicting items.</Description>
              <Name>ERROR_ON_MEMORY_EXHAUSTED</Name>
              <Value>0</Value>
              <ApplyType>STATIC</ApplyType>
              <AllowedValues>0,1</AllowedValues>
              <DefaultValue>0</DefaultValue>
            </OptionSetting>
            <OptionSetting>
              <DataType>INTEGER</DataType>
              <IsModifiable>true</IsModifiable>
              <IsCollection>false</IsCollection>
              <Description>The backlog queue configures how many network connections can be waiting to be processed by memcached</Description>
              <Name>BACKLOG_QUEUE_LIMIT</Name>
              <Value>1024</Value>
              <ApplyType>STATIC</ApplyType>
              <AllowedValues>1-2048</AllowedValues>
              <DefaultValue>1024</DefaultValue>
            </OptionSetting>
          </OptionSettings>
          <VpcSecurityGroupMemberships/>
          <Permanent>false</Permanent>
          <DBSecurityGroupMemberships>
            <DBSecurityGroup>
              <Status>authorized</Status>
              <DBSecurityGroupName>default</DBSecurityGroupName>
            </DBSecurityGroup>
          </DBSecurityGroupMemberships>
        </Option>
      </Options>
    </OptionGroup>
  </ModifyOptionGroupResult>
  <ResponseMetadata>
    <RequestId>073cfb45-c184-11d3-a537-cef97546330c</RequestId>
  </ResponseMetadata>
</ModifyOptionGroupResponse>
```

### Example
<a name="API_ModifyOptionGroup_Example_2"></a>

This example illustrates one usage of ModifyOptionGroup.

#### Sample Request
<a name="API_ModifyOptionGroup_Example_2_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=ModifyOptionGroup
    &ApplyImmediately=true
    &OptionGroupName=myawsuser-og02
    &OptionsToRemove.OptionName=MEMCACHED
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140501/us-east-1/rds/aws4_request
    &X-Amz-Date=20140501T231731Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=fd7ee924d39f1014488eb3444a8fdfb028e958b97703f95845a5addc435c1399
```

#### Sample Response
<a name="API_ModifyOptionGroup_Example_2_Response"></a>

```
<ModifyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyOptionGroupResult>
    <OptionGroup>
      <OptionGroupName>myawsuser-og02</OptionGroupName>
      <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships>
      <MajorEngineVersion>5.6</MajorEngineVersion>
      <EngineName>mysql</EngineName>
      <OptionGroupDescription>my second og</OptionGroupDescription>
      <Options/>
    </OptionGroup>
  </ModifyOptionGroupResult>
  <ResponseMetadata>
    <RequestId>b5f134f3-c185-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</ModifyOptionGroupResponse>
```

## See Also
<a name="API_ModifyOptionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyOptionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyOptionGroup) 

# ModifyTenantDatabase
<a name="API_ModifyTenantDatabase"></a>

Modifies 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.

## Request Parameters
<a name="API_ModifyTenantDatabase_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing DB instance.
Type: String  
Required: Yes

 ** TenantDBName **   
The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.  
Constraints:  
+ Must match the identifier of an existing tenant database.
Type: String  
Required: Yes

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
If the tenant database doesn't manage the master user password with AWS Secrets Manager, you can turn on this management. In this case, you can't specify `MasterUserPassword`.  
If the tenant database already manages the master user password with AWS Secrets Manager, and you specify that the master user password is not managed with AWS Secrets Manager, then you must specify `MasterUserPassword`. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by `MasterUserPassword`.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUserPassword **   
The new password for the master user of the specified tenant database in your DB instance.  
Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
Constraints:  
+ Can include any printable ASCII character except `/`, `"` (double quote), `@`, `&` (ampersand), and `'` (single quote).
Length constraints:  
+ Must contain between 8 and 30 characters. 
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if both of the following conditions are met:  
+ The tenant database doesn't manage the master user password in AWS Secrets Manager.

  If the tenant database already manages the master user password in AWS Secrets Manager, you can't change the KMS key used to encrypt the secret.
+ You're turning on `ManageMasterUserPassword` to manage the master user password in AWS Secrets Manager.

  If you're turning on `ManageMasterUserPassword` and don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a self-managed KMS key.
The AWS KMS key identifier is any of the following:  
+ Key ARN
+ Key ID
+ Alias ARN
+ Alias name for the KMS key
To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
A default KMS key exists for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** NewTenantDBName **   
The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.  
Constraints:  
+ Can't be the string null or any other reserved word.
+ Can't be longer than 8 characters.
Type: String  
Required: No

 ** RotateMasterUserPassword **   
Specifies whether to rotate the secret managed by AWS Secrets Manager for the master user password.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance. The secret value contains the updated password.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ You must apply the change immediately when rotating the master user password.
Type: Boolean  
Required: No

## Response Elements
<a name="API_ModifyTenantDatabase_ResponseElements"></a>

The following element is returned by the service.

 ** TenantDatabase **   
A tenant database in the DB instance. This data type is an element in the response to the `DescribeTenantDatabases` action.  
Type: [TenantDatabase](API_TenantDatabase.md) object

## Errors
<a name="API_ModifyTenantDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** TenantDatabaseAlreadyExists **   
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.  
HTTP Status Code: 400

 ** TenantDatabaseNotFound **   
The specified tenant database wasn't found in the DB instance.  
HTTP Status Code: 404

## See Also
<a name="API_ModifyTenantDatabase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ModifyTenantDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ModifyTenantDatabase) 

# PromoteReadReplica
<a name="API_PromoteReadReplica"></a>

Promotes a read replica DB instance to a standalone DB instance.

**Note**  
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the `backing-up` status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

## Request Parameters
<a name="API_PromoteReadReplica_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The DB instance identifier. This value is stored as a lowercase string.  
Constraints:  
+ Must match the identifier of an existing read replica DB instance.
Example: `mydbinstance`   
Type: String  
Required: Yes

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.  
Default: 1  
Constraints:  
+ Must be a value from 0 to 35.
+ Can't be set to 0 if the DB instance is a source to read replicas.
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

## Response Elements
<a name="API_PromoteReadReplica_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_PromoteReadReplica_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_PromoteReadReplica_Examples"></a>

### Example
<a name="API_PromoteReadReplica_Example_1"></a>

This example illustrates one usage of PromoteReadReplica.

#### Sample Request
<a name="API_PromoteReadReplica_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=PromoteReadReplica
   &BackupRetentionPeriod=7
   &DBInstanceIdentifier=mysqldb-rr
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T221536Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=c0b2cfc3db8334b6ef86922f664e05ab306754e30e408d9fd3c8e58069a9b386
```

#### Sample Response
<a name="API_PromoteReadReplica_Example_1_Response"></a>

```
<PromoteReadReplicaResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <PromoteReadReplicaResult>
    <DBInstance>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <DBInstanceStatus>modifying</DBInstanceStatus>
      <MultiAZ>false</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mysqldb-rr</DBInstanceIdentifier>
      <PreferredBackupWindow>08:25-08:55</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <StatusInfos>
        <DBInstanceStatusInfo>
          <Status>replicating</Status>
          <StatusType>read replication</StatusType>
          <Normal>true</Normal>
        </DBInstanceStatusInfo>
      </StatusInfos>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <ReadReplicaDBInstanceIdentifiers/>
      <Engine>mysql</Engine>
      <PendingModifiedValues>
        <BackupRetentionPeriod>7</BackupRetentionPeriod>
      </PendingModifiedValues>
      <LicenseModel>general-public-license</LicenseModel>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <Endpoint>
        <Port>3306</Port>
        <Address>mysqldb-rr.cg029hpkxcjt.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <EngineVersion>5.6.13</EngineVersion>
      <ReadReplicaSourceDBInstanceIdentifier>mysqldb</ReadReplicaSourceDBInstanceIdentifier>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <DBName>mysqldb</DBName>
      <InstanceCreateTime>2014-04-25T17:12:34.460Z</InstanceCreateTime>
      <AllocatedStorage>100</AllocatedStorage>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
      <MasterUsername>myawsuser</MasterUsername>
    </DBInstance>
  </PromoteReadReplicaResult>
  <ResponseMetadata>
    <RequestId>8e8c0d64-be21-11d3-a71c-13dc2f771e41</RequestId>
  </ResponseMetadata>
</PromoteReadReplicaResponse>
```

## See Also
<a name="API_PromoteReadReplica_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/PromoteReadReplica) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PromoteReadReplica) 

# PromoteReadReplicaDBCluster
<a name="API_PromoteReadReplicaDBCluster"></a>

Promotes a read replica DB cluster to a standalone DB cluster.

## Request Parameters
<a name="API_PromoteReadReplicaDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing DB cluster read replica.
Example: `my-cluster-replica1`   
Type: String  
Required: Yes

## Response Elements
<a name="API_PromoteReadReplicaDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_PromoteReadReplicaDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_PromoteReadReplicaDBCluster_Examples"></a>

### Example
<a name="API_PromoteReadReplicaDBCluster_Example_1"></a>

This example illustrates one usage of PromoteReadReplicaDBCluster.

#### Sample Request
<a name="API_PromoteReadReplicaDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=PromoteReadReplicaDBCluster
   &DBClusterIdentifier=my-cluster-replica1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20160328/us-east-1/rds/aws4_request
   &X-Amz-Date=20160328T221226Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e2b2cfc3db7766b6ef86922f664e05ab306754e30e408d9fd3c8e58069a9b386
```

#### Sample Response
<a name="API_PromoteReadReplicaDBCluster_Example_1_Response"></a>

```
<PromoteReadReplicaDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <PromoteReadReplicaDBClusterResult>
    <DBCluster>
      <Port>3306</Port>
      <Engine>aurora</Engine>
      <Status>creating</Status>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <Status>active</Status>
          <VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <DBSubnetGroup>default</DBSubnetGroup>
      <EngineVersion>5.6.10a</EngineVersion>
      <Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <AvailabilityZones>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <AvailabilityZone>us-east-1e</AvailabilityZone>
      </AvailabilityZones>
      <DBClusterIdentifier>my-cluster-replica1</DBClusterIdentifier>
      <PreferredBackupWindow>04:22-04:52</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow>
        <DBClusterMembers>
          <DBClusterMember>
            <IsClusterWriter>true</IsClusterWriter>
            <DBInstanceIdentifier>my-cluster1-master</DBInstanceIdentifier>
          </DBClusterMember>
          <DBClusterMember>
            <IsClusterWriter>false</IsClusterWriter>
            <DBInstanceIdentifier>my-cluster1-read1</DBInstanceIdentifier>
          </DBClusterMember>
        </DBClusterMembers>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBCluster>
  </PromoteReadReplicaDBClusterResult>
  <ResponseMetadata>
    <RequestId>8e8c0d64-be21-11d3-a71c-13dc2f771e41</RequestId>
  </ResponseMetadata>
</PromoteReadReplicaDBClusterResponse>
```

## See Also
<a name="API_PromoteReadReplicaDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/PromoteReadReplicaDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PromoteReadReplicaDBCluster) 

# PurchaseReservedDBInstancesOffering
<a name="API_PurchaseReservedDBInstancesOffering"></a>

Purchases a reserved DB instance offering.

## Request Parameters
<a name="API_PurchaseReservedDBInstancesOffering_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReservedDBInstancesOfferingId **   
The ID of the Reserved DB instance offering to purchase.  
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706  
Type: String  
Required: Yes

 ** DBInstanceCount **   
The number of instances to reserve.  
Default: `1`   
Type: Integer  
Required: No

 ** ReservedDBInstanceId **   
Customer-specified identifier to track this reservation.  
Example: myreservationID  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_PurchaseReservedDBInstancesOffering_ResponseElements"></a>

The following element is returned by the service.

 ** ReservedDBInstance **   
This data type is used as a response element in the `DescribeReservedDBInstances` and `PurchaseReservedDBInstancesOffering` actions.  
Type: [ReservedDBInstance](API_ReservedDBInstance.md) object

## Errors
<a name="API_PurchaseReservedDBInstancesOffering_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ReservedDBInstanceAlreadyExists **   
User already has a reservation with the given identifier.  
HTTP Status Code: 404

 ** ReservedDBInstanceQuotaExceeded **   
Request would exceed the user's DB Instance quota.  
HTTP Status Code: 400

 ** ReservedDBInstancesOfferingNotFound **   
Specified offering does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_PurchaseReservedDBInstancesOffering_Examples"></a>

### Example
<a name="API_PurchaseReservedDBInstancesOffering_Example_1"></a>

This example illustrates one usage of PurchaseReservedDBInstancesOffering.

#### Sample Request
<a name="API_PurchaseReservedDBInstancesOffering_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=PurchaseReservedDBInstancesOffering
   &ReservedDBInstanceId=myreservationID
   &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706
   &DBInstanceCount=10
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140415/us-east-1/rds/aws4_request
   &X-Amz-Date=20140415T232655Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=c2ac761e8c8f54a8c0727f5a87ad0a766fbb0024510b9aa34ea6d1f7df52fb11
```

#### Sample Response
<a name="API_PurchaseReservedDBInstancesOffering_Example_1_Response"></a>

```
<PurchaseReservedDBInstancesOfferingResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <PurchaseReservedDBInstancesOfferingResult>
    <ReservedDBInstance>
      <OfferingType>Partial Upfront</OfferingType>
      <CurrencyCode>USD</CurrencyCode>
      <RecurringCharges/>
      <ProductDescription>mysql</ProductDescription>
      <ReservedDBInstancesOfferingId>438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedDBInstancesOfferingId>
      <MultiAZ>true</MultiAZ>
      <State>payment-pending</State>
      <ReservedDBInstanceId>myreservationID</ReservedDBInstanceId>
      <DBInstanceCount>10</DBInstanceCount>
      <StartTime>2014-05-18T23:24:56.577Z</StartTime>
      <Duration>31536000</Duration>
      <FixedPrice>123.0</FixedPrice>
      <UsagePrice>0.123</UsagePrice>
      <DBInstanceClass>db.m1.small</DBInstanceClass>
    </ReservedDBInstance>
  </PurchaseReservedDBInstancesOfferingResult>
  <ResponseMetadata>
    <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</PurchaseReservedDBInstancesOfferingResponse>
```

## See Also
<a name="API_PurchaseReservedDBInstancesOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/PurchaseReservedDBInstancesOffering) 

# RebootDBCluster
<a name="API_RebootDBCluster"></a>

You 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 database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_RebootDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ Must match the identifier of an existing DBCluster.
Type: String  
Required: Yes

## Response Elements
<a name="API_RebootDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_RebootDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_RebootDBCluster_Examples"></a>

### Example
<a name="API_RebootDBCluster_Example_1"></a>

This example illustrates one usage of RebootDBCluster.

#### Sample Request
<a name="API_RebootDBCluster_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=RebootDBCluster
   &DBClusterIdentifier=my-multi-az-cluster
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20211014/us-west-2/rds/aws4_request
   &X-Amz-Date=20211020T204924Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=1c48f44c14183cff26fde7d912946f87f3bb9d715f66448f457a8f9e99602af5
```

#### Sample Response
<a name="API_RebootDBCluster_Example_1_Response"></a>

```
<RebootDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RebootDBClusterResult>
    <DBCluster>
      <CrossAccountClone>false</CrossAccountClone>
      <AllocatedStorage>100</AllocatedStorage>
      <DatabaseName>mydb</DatabaseName>
      <AssociatedRoles />
      <AvailabilityZones>
        <AvailabilityZone>us-west-2a</AvailabilityZone>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <AvailabilityZone>us-west-2c</AvailabilityZone>
      </AvailabilityZones>
      <ReadReplicaIdentifiers />
      <Iops>1000</Iops>
      <PerformanceInsightsKMSKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</PerformanceInsightsKMSKeyId>
      <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod>
      <EngineVersion>8.0.26</EngineVersion>
      <MasterUsername>admin</MasterUsername>
      <DBClusterMembers>
        <DBClusterMember>
          <DBInstanceIdentifier>my-multi-az-cluster-instance-3</DBInstanceIdentifier>
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
          <PromotionTier>1</PromotionTier>
          <IsClusterWriter>false</IsClusterWriter>
        </DBClusterMember>
        <DBClusterMember>
          <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier>
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
          <PromotionTier>1</PromotionTier>
          <IsClusterWriter>false</IsClusterWriter>
        </DBClusterMember>
        <DBClusterMember>
          <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier>
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus>
          <PromotionTier>1</PromotionTier>
          <IsClusterWriter>true</IsClusterWriter>
        </DBClusterMember>
      </DBClusterMembers>
      <HttpEndpointEnabled>false</HttpEndpointEnabled>
      <Port>3306</Port>
      <MonitoringInterval>30</MonitoringInterval>
      <BackupRetentionPeriod>2</BackupRetentionPeriod>
      <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId>
      <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier>
      <DbClusterResourceId>cluster-RCPGZXFNIHCTBQLDRJX6CP62VQ</DbClusterResourceId>
      <LatestRestorableTime>2021-10-20T20:45:00Z</LatestRestorableTime>
      <Status>available</Status>
      <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow>
      <DeletionProtection>false</DeletionProtection>
      <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint>
      <EngineMode>provisioned</EngineMode>
      <Engine>mysql</Engine>
      <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint>
      <PubliclyAccessible>true</PubliclyAccessible>
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
      <EarliestRestorableTime>2021-10-20T00:21:43.013Z</EarliestRestorableTime>
      <ClusterCreateTime>2021-10-20T00:12:00.867Z</ClusterCreateTime>
      <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled>
      <MultiAZ>true</MultiAZ>
      <DomainMemberships />
      <MonitoringRoleArn>arn:aws:iam::123456789012:role/enhance-monitoring-role</MonitoringRoleArn>
      <StorageEncrypted>true</StorageEncrypted>
      <DBSubnetGroup>mysubnet1</DBSubnetGroup>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <TagList />
      <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId>
      <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow>
      <DBClusterParameterGroup>my-multi-az-cluster-cpg</DBClusterParameterGroup>
      <StorageType>io1</StorageType>
      <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn>
    </DBCluster>
  </RebootDBClusterResult>
  <ResponseMetadata>
    <RequestId>056383d9-2d62-415d-b1bb-098b4cc86b5d</RequestId>
  </ResponseMetadata>
</RebootDBClusterResponse>
```

## See Also
<a name="API_RebootDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RebootDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RebootDBCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see [Rebooting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html) in the *Amazon RDS User Guide.* 

This command doesn't apply to RDS Custom.

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the `RebootDBCluster` operation.

## Request Parameters
<a name="API_RebootDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The DB instance identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ Must match the identifier of an existing DBInstance.
Type: String  
Required: Yes

 ** ForceFailover **   
Specifies whether the reboot is conducted through a Multi-AZ failover.  
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_RebootDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_RebootDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

## Examples
<a name="API_RebootDBInstance_Examples"></a>

### Example
<a name="API_RebootDBInstance_Example_1"></a>

This example illustrates one usage of RebootDBInstance.

#### Sample Request
<a name="API_RebootDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=RebootDBInstance
   &DBInstanceIdentifier=mysqldb
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T222011Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=1c48f44c14183cff26fde7d912946f87f3bb9d715f66448f457a8f9e99602af5
```

#### Sample Response
<a name="API_RebootDBInstance_Example_1_Response"></a>

```
<RebootDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RebootDBInstanceResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DBInstanceStatus>rebooting</DBInstanceStatus>
      <MultiAZ>false</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
      <PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <ReadReplicaDBInstanceIdentifiers/>
      <LatestRestorableTime>2014-04-28T22:15:00Z</LatestRestorableTime>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <Endpoint>
        <Port>3306</Port>
        <Address>mysqldb.cb036hpkmopt.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>mysqldb</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <InstanceCreateTime>2014-04-21T22:24:26.573Z</InstanceCreateTime>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
    </DBInstance>
  </RebootDBInstanceResult>
  <ResponseMetadata>
    <RequestId>33c99cd2-be22-11d3-abdb-7cb19376fb1c</RequestId>
  </ResponseMetadata>
</RebootDBInstanceResponse>
```

## See Also
<a name="API_RebootDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RebootDBInstance) 

# RebootDBShardGroup
<a name="API_RebootDBShardGroup"></a>

You 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.

## Request Parameters
<a name="API_RebootDBShardGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBShardGroupIdentifier **   
The name of the DB shard group to reboot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

## Response Elements
<a name="API_RebootDBShardGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ComputeRedundancy **   
Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:  
+ 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
+ 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
+ 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
Type: Integer

 ** DBClusterIdentifier **   
The name of the primary DB cluster for the DB shard group.  
Type: String

 ** DBShardGroupArn **   
The Amazon Resource Name (ARN) for the DB shard group.  
Type: String

 ** DBShardGroupIdentifier **   
The name of the DB shard group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*` 

 ** DBShardGroupResourceId **   
The AWS Region-unique, immutable identifier for the DB shard group.  
Type: String

 ** Endpoint **   
The connection endpoint for the DB shard group.  
Type: String

 ** MaxACU **   
The maximum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** MinACU **   
The minimum capacity of the DB shard group in Aurora capacity units (ACUs).  
Type: Double

 ** PubliclyAccessible **   
Indicates whether the DB shard group is publicly accessible.  
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.  
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBShardGroup](API_CreateDBShardGroup.md).  
This setting is only for Aurora Limitless Database.  
Type: Boolean

 ** Status **   
The status of the DB shard group.  
Type: String

 **TagList.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_RebootDBShardGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** InvalidDBShardGroupState **   
The DB shard group must be in the available state.  
HTTP Status Code: 400

## See Also
<a name="API_RebootDBShardGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RebootDBShardGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RebootDBShardGroup) 

# RegisterDBProxyTargets
<a name="API_RegisterDBProxyTargets"></a>

Associate one or more `DBProxyTarget` data structures with a `DBProxyTargetGroup`.

## Request Parameters
<a name="API_RegisterDBProxyTargets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBProxyName **   
The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: Yes

 **DBClusterIdentifiers.member.N**   
One or more DB cluster identifiers.  
Type: Array of strings  
Required: No

 **DBInstanceIdentifiers.member.N**   
One or more DB instance identifiers.  
Type: Array of strings  
Required: No

 ** TargetGroupName **   
The identifier of the `DBProxyTargetGroup`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `[a-zA-Z](?:-?[a-zA-Z0-9]+)*`   
Required: No

## Response Elements
<a name="API_RegisterDBProxyTargets_ResponseElements"></a>

The following element is returned by the service.

 **DBProxyTargets.member.N**   
One or more `DBProxyTarget` objects that are created when you register targets with a target group.  
Type: Array of [DBProxyTarget](API_DBProxyTarget.md) objects

## Errors
<a name="API_RegisterDBProxyTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetAlreadyRegisteredFault **   
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.  
HTTP Status Code: 400

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** InsufficientAvailableIPsInSubnetFault **   
The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBProxyStateFault **   
The requested operation can't be performed while the proxy is in this state.  
HTTP Status Code: 400

## See Also
<a name="API_RegisterDBProxyTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RegisterDBProxyTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RegisterDBProxyTargets) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

**Note**  
This operation only applies to Aurora DB clusters.

## Request Parameters
<a name="API_RemoveFromGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DbClusterIdentifier **   
The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.  
Type: String  
Required: Yes

 ** GlobalClusterIdentifier **   
The cluster identifier to detach from the Aurora global database cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

## Response Elements
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_RemoveFromGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## See Also
<a name="API_RemoveFromGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RemoveFromGlobalCluster) 

# RemoveRoleFromDBCluster
<a name="API_RemoveRoleFromDBCluster"></a>

Removes the asssociation of an AWS Identity and Access Management (IAM) role from a DB cluster.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_RemoveRoleFromDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the DB cluster to disassociate the IAM role from.  
Type: String  
Required: Yes

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example `arn:aws:iam::123456789012:role/AuroraAccessRole`.  
Type: String  
Required: Yes

 ** FeatureName **   
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see [DBEngineVersion](API_DBEngineVersion.md).  
Type: String  
Required: No

## Errors
<a name="API_RemoveRoleFromDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterRoleNotFound **   
The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_RemoveRoleFromDBCluster_Examples"></a>

### Example
<a name="API_RemoveRoleFromDBCluster_Example_1"></a>

This example illustrates one usage of RemoveRoleFromDBCluster.

#### Sample Request
<a name="API_RemoveRoleFromDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=RemoveRoleFromDBCluster
    &DBClusterIdentifier=sample-cluster
    &RoleArn=arn%3Aaws%3Aiam%3A%3A123456789012%3Arole%2Fsample-role
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20161012/us-east-1/rds/aws4_request
    &X-Amz-Date=20161012T204525Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=cd7d5005d56a505b4e2a878c297e6f8a3cc26b19a335ede018ba41f3185c92a2
```

#### Sample Response
<a name="API_RemoveRoleFromDBCluster_Example_1_Response"></a>

```
<RemoveRoleFromDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>ccfca75a-90bc-11e6-8533-cd6377e421f8</RequestId>
  </ResponseMetadata>
</RemoveRoleFromDBClusterResponse>
```

## See Also
<a name="API_RemoveRoleFromDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RemoveRoleFromDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RemoveRoleFromDBCluster) 

# RemoveRoleFromDBInstance
<a name="API_RemoveRoleFromDBInstance"></a>

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

## Request Parameters
<a name="API_RemoveRoleFromDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The name of the DB instance to disassociate the IAM role from.  
Type: String  
Required: Yes

 ** FeatureName **   
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see `DBEngineVersion`.  
Type: String  
Required: Yes

 ** RoleArn **   
The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, `arn:aws:iam::123456789012:role/AccessRole`.  
Type: String  
Required: Yes

## Errors
<a name="API_RemoveRoleFromDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBInstanceRoleNotFound **   
The specified `RoleArn` value doesn't match the specified feature for the DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_RemoveRoleFromDBInstance_Examples"></a>

### Example
<a name="API_RemoveRoleFromDBInstance_Example_1"></a>

This example illustrates one usage of RemoveRoleFromDBInstance.

#### Sample Request
<a name="API_RemoveRoleFromDBInstance_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=RemoveRoleFromDBInstance
    &DBInstanceIdentifier=sample-instance
    &RoleArn=arn%3Aaws%3Aiam%3A%3A123456789012%3Arole%2Fsample-role
    &FeatureName=s3Import
```

## See Also
<a name="API_RemoveRoleFromDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RemoveRoleFromDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RemoveRoleFromDBInstance) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

Removes a source identifier from an existing RDS event notification subscription.

## Request Parameters
<a name="API_RemoveSourceIdentifierFromSubscription_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceIdentifier **   
The source identifier to be removed from the subscription, such as the **DB instance identifier** for a DB instance or the name of a security group.  
Type: String  
Required: Yes

 ** SubscriptionName **   
The name of the RDS event notification subscription you want to remove a source identifier from.  
Type: String  
Required: Yes

## Response Elements
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

The following element is returned by the service.

 ** EventSubscription **   
Contains the results of a successful invocation of the `DescribeEventSubscriptions` action.  
Type: [EventSubscription](API_EventSubscription.md) object

## Errors
<a name="API_RemoveSourceIdentifierFromSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** SourceNotFound **   
The requested source could not be found.  
HTTP Status Code: 404

 ** SubscriptionNotFound **   
The subscription name does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_RemoveSourceIdentifierFromSubscription_Examples"></a>

### Example
<a name="API_RemoveSourceIdentifierFromSubscription_Example_1"></a>

This example illustrates one usage of RemoveSourceIdentifierFromSubscription.

#### Sample Request
<a name="API_RemoveSourceIdentifierFromSubscription_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=RemoveSourceIdentifierFromSubscription
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceIdentifier=si-sample
   &SubscriptionName=myawsuser-secgrp
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T222718Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4419f0015657ee120d781849ffdc6642eeafeee42bf1d18c4b2ed8eb732f7bf8
```

#### Sample Response
<a name="API_RemoveSourceIdentifierFromSubscription_Example_1_Response"></a>

```
<RemoveSourceIdentifierFromSubscriptionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RemoveSourceIdentifierFromSubscriptionResult>
    <EventSubscription>
      <Enabled>true</Enabled>
      <CustomerAwsId>802#########</CustomerAwsId>
      <SourceType>db-security-group</SourceType>
      <Status>active</Status>
      <SubscriptionCreationTime>2014-04-25 21:43:25.542</SubscriptionCreationTime>
      <EventCategoriesList>
        <EventCategory>configuration change</EventCategory>
        <EventCategory>failure</EventCategory>
      </EventCategoriesList>
      <CustSubscriptionId>myawsuser-secgrp</CustSubscriptionId>
      <SnsTopicArn>arn:aws:sns:us-east-1:802#########:myawsuser-RDS</SnsTopicArn>
    </EventSubscription>
  </RemoveSourceIdentifierFromSubscriptionResult>
  <ResponseMetadata>
    <RequestId>326cdeb9-be23-11d3-91a5-a90441261bc4</RequestId>
  </ResponseMetadata>
</RemoveSourceIdentifierFromSubscriptionResponse>
```

## See Also
<a name="API_RemoveSourceIdentifierFromSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see [ Constructing an ARN for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the *Amazon RDS User Guide.*   
Type: String  
Required: Yes

 **TagKeys.member.N**   
The tag key (name) of the tag to be removed.  
Type: Array of strings  
Required: Yes

## Errors
<a name="API_RemoveTagsFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBProxyEndpointNotFoundFault **   
The DB proxy endpoint doesn't exist.  
HTTP Status Code: 404

 ** DBProxyNotFoundFault **   
The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBProxyTargetGroupNotFoundFault **   
The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.  
HTTP Status Code: 404

 ** DBShardGroupNotFound **   
The specified DB shard group name wasn't found.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSnapshotTenantDatabaseNotFoundFault **   
The specified snapshot tenant database wasn't found.  
HTTP Status Code: 404

 ** IntegrationNotFoundFault **   
The specified integration could not be found.  
HTTP Status Code: 404

 ** InvalidDBClusterEndpointStateFault **   
The requested operation can't be performed on the endpoint while the endpoint is in this state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** TenantDatabaseNotFound **   
The specified tenant database wasn't found in the DB instance.  
HTTP Status Code: 404

## Examples
<a name="API_RemoveTagsFromResource_Examples"></a>

### Example
<a name="API_RemoveTagsFromResource_Example_1"></a>

This example illustrates one usage of RemoveTagsFromResource.

#### Sample Request
<a name="API_RemoveTagsFromResource_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=RemoveTagsFromResource
    &ResourceName=arn%3Aaws%3Ards%3Aus-west-2%3A123456789012%3Adb%3Asample
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &TagKeys.member.1=InstanceType
    &TagKeys.member.2=Owner
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
    &X-Amz-Date=20160913T174918Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=4c72f307a75444461bd9b9ccb7de361fec75b8adad66a52824226320d0a33ca8
```

#### Sample Response
<a name="API_RemoveTagsFromResource_Example_1_Response"></a>

```
<RemoveTagsFromResourceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResponseMetadata>
    <RequestId>126d40cc-79da-11e6-b8e4-29f0c684be5d</RequestId>
  </ResponseMetadata>
</RemoveTagsFromResourceResponse>
```

## See Also
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

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 DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_ResetDBClusterParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to reset.  
Type: String  
Required: Yes

 **Parameters.Parameter.N**   
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the `ResetAllParameters` parameter is enabled.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 ** ResetAllParameters **   
Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the `Parameters` parameter.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group.  
Constraints:  
+ Must be 1 to 255 letters or numbers.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Type: String

## Errors
<a name="API_ResetDBClusterParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_ResetDBClusterParameterGroup_Examples"></a>

### Example
<a name="API_ResetDBClusterParameterGroup_Example_1"></a>

This example illustrates one usage of ResetDBClusterParameterGroup.

#### Sample Request
<a name="API_ResetDBClusterParameterGroup_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=ResetDBClusterParameterGroup
    &DBClusterParameterGroupName=sample-cluster-pg
    &Parameters.member.1.ApplyMethod=pending-reboot
    &Parameters.member.1.ParameterName=binlog_format
    &Parameters.member.2.ApplyMethod=pending-reboot
    &Parameters.member.2.ParameterName=innodb_support_xa
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
    &X-Amz-Date=20160913T230026Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=7cca4504082065e227696f2dd904fab2f39633bc7d120258c4bedd35da3ade7f
```

#### Sample Response
<a name="API_ResetDBClusterParameterGroup_Example_1_Response"></a>

```
<ResetDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResetDBClusterParameterGroupResult>
    <DBClusterParameterGroupName>sample-cluster-pg</DBClusterParameterGroupName>
  </ResetDBClusterParameterGroupResult>
  <ResponseMetadata>
    <RequestId>dc2c61eb-7a05-11e6-b83b-cd70a540d79f</RequestId>
  </ResponseMetadata>
</ResetDBClusterParameterGroupResponse>
```

## See Also
<a name="API_ResetDBClusterParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ResetDBClusterParameterGroup) 

# ResetDBParameterGroup
<a name="API_ResetDBParameterGroup"></a>

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.

## Request Parameters
<a name="API_ResetDBParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Constraints:  
+ Must match the name of an existing `DBParameterGroup`.
Type: String  
Required: Yes

 **Parameters.Parameter.N**   
To reset the entire DB parameter group, specify the `DBParameterGroup` name and `ResetAllParameters` parameters. To reset specific parameters, provide a list of the following: `ParameterName` and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request.  
 **MySQL**   
Valid Values (for Apply method): `immediate` \$1 `pending-reboot`   
You can use the immediate value with dynamic parameters only. You can use the `pending-reboot` value for both dynamic and static parameters, and changes are applied when DB instance reboots.  
 **MariaDB**   
Valid Values (for Apply method): `immediate` \$1 `pending-reboot`   
You can use the immediate value with dynamic parameters only. You can use the `pending-reboot` value for both dynamic and static parameters, and changes are applied when DB instance reboots.  
 **Oracle**   
Valid Values (for Apply method): `pending-reboot`   
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 ** ResetAllParameters **   
Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_ResetDBParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** DBParameterGroupName **   
The name of the DB parameter group.  
Type: String

## Errors
<a name="API_ResetDBParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** InvalidDBParameterGroupState **   
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.  
HTTP Status Code: 400

## Examples
<a name="API_ResetDBParameterGroup_Examples"></a>

### Example
<a name="API_ResetDBParameterGroup_Example_1"></a>

This example illustrates one usage of ResetDBParameterGroup.

#### Sample Request
<a name="API_ResetDBParameterGroup_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ResetDBParameterGroup
   &DBParameterGroupName=mydbparametergroup01
   &ResetAllParameters=true
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T225714Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=709d1418c91c5ef4129d4665e5c2820002a9665699acf4204683c778f03c3573
```

#### Sample Response
<a name="API_ResetDBParameterGroup_Example_1_Response"></a>

```
<ResetDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResetDBParameterGroupResult>
    <DBParameterGroupName>mydbparametergroup01</DBParameterGroupName>
  </ResetDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>610909c6-be27-11d3-a71c-13dc2f771e41</RequestId>
  </ResponseMetadata>
</ResetDBParameterGroupResponse>
```

### Example
<a name="API_ResetDBParameterGroup_Example_2"></a>

This example illustrates one usage of ResetDBParameterGroup.

#### Sample Request
<a name="API_ResetDBParameterGroup_Example_2_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=ResetDBParameterGroup
   &DBParameterGroupName=mydbparametergroup01
   &Parameters.member.1.ApplyMethod=immediate
   &Parameters.member.1.ParameterName=bulk_insert_buffer_size
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T230509Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=d343dd7fcc3789d30295b5e3fc67262f28af15d71fcaf978921f0e8846b2d1e6
```

#### Sample Response
<a name="API_ResetDBParameterGroup_Example_2_Response"></a>

```
<ResetDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ResetDBParameterGroupResult>
    <DBParameterGroupName>mydbparametergroup01</DBParameterGroupName>
  </ResetDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>7acb72cf-be28-11d3-a4fc-e3b7f6c20c5f</RequestId>
  </ResponseMetadata>
</ResetDBParameterGroupResponse>
```

## See Also
<a name="API_ResetDBParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/ResetDBParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/ResetDBParameterGroup) 

# RestoreDBClusterFromS3
<a name="API_RestoreDBClusterFromS3"></a>

Creates 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3) in the *Amazon Aurora User Guide*.

**Note**  
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the `CreateDBInstance` operation 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 `RestoreDBClusterFromS3` operation has completed and the DB cluster is available.

For more information on Amazon Aurora, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

## Request Parameters
<a name="API_RestoreDBClusterFromS3_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-cluster1`   
Type: String  
Required: Yes

 ** Engine **   
The name of the database engine to be used for this DB cluster.  
Valid Values: `aurora-mysql` (for Aurora MySQL)  
Type: String  
Required: Yes

 ** MasterUsername **   
The name of the master user for the restored DB cluster.  
Constraints:  
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
Type: String  
Required: Yes

 ** S3BucketName **   
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.  
Type: String  
Required: Yes

 ** S3IngestionRoleArn **   
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.  
Type: String  
Required: Yes

 ** SourceEngine **   
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.  
Valid Values: `mysql`   
Type: String  
Required: Yes

 ** SourceEngineVersion **   
The version of the database that the backup files were created from.  
MySQL versions 5.7 and 8.0 are supported.  
Example: `5.7.40`, `8.0.28`   
Type: String  
Required: Yes

 **AvailabilityZones.AvailabilityZone.N**   
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.  
Type: Array of strings  
Required: No

 ** BacktrackWindow **   
The target backtrack window, in seconds. To disable backtracking, set this value to 0.  
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0  
Constraints:  
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Type: Long  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.  
Default: 1  
Constraints:  
+ Must be a value from 1 to 35
Type: Integer  
Required: No

 ** CharacterSetName **   
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.  
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.  
Type: Boolean  
Required: No

 ** DatabaseName **   
The database name for the restored DB cluster.  
Type: String  
Required: No

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.  
Constraints:  
+ If supplied, must match the name of an existing DBClusterParameterGroup.
Type: String  
Required: No

 ** DBSubnetGroupName **   
A DB subnet group to associate with the restored DB cluster.  
Constraints: If supplied, must match the name of an existing DBSubnetGroup.  
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.  
Type: Boolean  
Required: No

 ** Domain **   
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.  
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** DomainIAMRoleName **   
Specify the name of the IAM role to be used when making API calls to the Directory Service.  
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.  
 **Aurora MySQL**   
Possible values are `audit`, `error`, `general`, `instance`, `slowquery`, and `iam-db-auth-error`.  
 **Aurora PostgreSQL**   
Possible value are `instance`, `postgresql`, and `iam-db-auth-error`.  
For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Type: Array of strings  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide*.  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB cluster.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:  
+ Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* 
+ Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* 
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to use.  
To list all of the available engine versions for `aurora-mysql` (Aurora MySQL), use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`   
 **Aurora MySQL**   
Examples: `5.7.mysql_aurora.2.12.0`, `8.0.mysql_aurora.3.04.0`   
Type: String  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB cluster.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If the StorageEncrypted parameter is enabled, and you do not specify a value for the `KmsKeyId` parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUserPassword **   
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".  
Constraints:  
+ Must contain from 8 to 41 characters.
+ Can't be specified if `ManageMasterUserPassword` is turned on.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB cluster.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB cluster.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*   
Type: String  
Required: No

 ** OptionGroupName **   
A value that indicates that the restored DB cluster should be associated with the specified option group.  
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.  
Type: String  
Required: No

 ** Port **   
The port number on which the instances in the restored DB cluster accept connections.  
Default: `3306`   
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To view the time blocks available, see [ Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide*.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).  
Format: `ddd:hh24:mi-ddd:hh24:mi`   
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide*.  
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.  
Constraints: Minimum 30-minute window.  
Type: String  
Required: No

 ** S3Prefix **   
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a **SourceS3Prefix** value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.  
Type: String  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.  
For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** StorageEncrypted **   
Specifies whether the restored DB cluster is encrypted.  
Type: Boolean  
Required: No

 ** StorageType **   
Specifies the storage type to be associated with the DB cluster.  
Valid Values: `aurora`, `aurora-iopt1`   
Default: `aurora`   
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB cluster.  
Valid Values:   
+  `cluster-auto-backup` - The DB cluster's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of EC2 VPC security groups to associate with the restored DB cluster.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBClusterFromS3_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_RestoreDBClusterFromS3_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
The user already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InsufficientStorageClusterCapacity **   
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBSubnetGroupStateFault **   
The DB subnet group cannot be deleted because it's in use.  
HTTP Status Code: 400

 ** InvalidS3BucketFault **   
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the **SourceS3BucketName** and **S3IngestionRoleArn** values and try again.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

## Examples
<a name="API_RestoreDBClusterFromS3_Examples"></a>

### Example
<a name="API_RestoreDBClusterFromS3_Example_1"></a>

This example illustrates one usage of RestoreDBClusterFromS3.

#### Sample Request
<a name="API_RestoreDBClusterFromS3_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=RestoreDBClusterFromS3
    &DBClusterIdentifier=sample-cluster
    &Engine=aurora-mysql
    &S3BucketName=s3-ingestion-sample
    &SourceEngine=mysql
    &SourceEngineVersion=8.0.mysql_aurora.3.04.0
    &MasterUsername=myawsuser
    &MasterUserPassword=<password>
    &S3IngestionRoleArn=arn:aws:iam:123456789012:role/sample-role
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &SnapshotIdentifier=sample-snapshot
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230223/us-east-1/rds/aws4_request
    &X-Amz-Date=20230223T165638Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=c59effef9b7b96f6a8dfed7873611df555364594f7f9acf9cd14d353114771fd
```

#### Sample Response
<a name="API_RestoreDBClusterFromS3_Example_1_Response"></a>

```
<RestoreDBClusterFromS3Response xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBClusterFromS3Result>
    <DBCluster>
      <Port>3306</Port>
      <Engine>aurora-mysql</Engine>
      <Status>creating</Status>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <Status>active</Status>
          <VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <DBSubnetGroup>default</DBSubnetGroup>
      <EngineVersion>8.0.mysql_aurora.3.04.0</EngineVersion>
      <Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <AvailabilityZones>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <AvailabilityZone>us-east-1e</AvailabilityZone>
      </AvailabilityZones>
      <DBClusterIdentifier>sample-cluster</DBClusterIdentifier>
      <PreferredBackupWindow>04:22-04:52</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow>
      <DBClusterMembers/>
      <AllocatedStorage>1</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBCluster>
  </RestoreDBClusterFromS3Result>
  <ResponseMetadata>
    <RequestId>46d2b228-7681-11e5-3e8b-9b2c0d5d51a9</RequestId>
  </ResponseMetadata>
</RestoreDBClusterFromS3Response>
```

## See Also
<a name="API_RestoreDBClusterFromS3_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBClusterFromS3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBClusterFromS3) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

Creates 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.

You can use the `EnableVPCNetworking` and `EnableInternetAccessGateway` parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set `EnableVPCNetworking` to `false` to disable the VPC network interface (ENI) for the cluster. `EnableInternetAccessGateway` enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using `EnableIAMDatabaseAuthentication`. Once the cluster is restored, you need to modify the DB cluster to update `MasterUserAuthenticationType` to `iam-db-auth`. 

**Note**  
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the `CreateDBInstance` operation 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 `RestoreDBClusterFromSnapshot` operation has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Example: `my-snapshot-id`   
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: Yes

 ** Engine **   
The database engine to use for the new DB cluster.  
Default: The same as source  
Constraint: Must be compatible with the engine of the source  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: Yes

 ** SnapshotIdentifier **   
The identifier for the DB snapshot or DB cluster snapshot to restore from.  
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.  
Constraints:  
+ Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: Yes

 **AvailabilityZones.AvailabilityZone.N**   
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.  
Valid for: Aurora DB clusters only  
Type: Array of strings  
Required: No

 ** BacktrackWindow **   
The target backtrack window, in seconds. To disable backtracking, set this value to 0.  
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0  
Constraints:  
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only  
Type: Long  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Specify a minimum value of `1`.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Default: Uses existing setting  
Constraints:  
+ Must be a value from 1 to 35.
Type: Integer  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** DatabaseName **   
The database name for the restored DB cluster.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DBClusterInstanceClass **   
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines.  
For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.*   
Valid for: Multi-AZ DB clusters only  
Type: String  
Required: No

 ** DBClusterParameterGroupName **   
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.  
Constraints:  
+ If supplied, must match the name of an existing default DB cluster parameter group.
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DBSubnetGroupName **   
The name of the DB subnet group to use for the new DB cluster.  
Constraints: If supplied, must match the name of an existing DB subnet group.  
Example: `mydbsubnetgroup`   
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to be used when making API calls to the Directory Service.  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.  
 **RDS for MySQL**   
Possible values are `error`, `general`, `slowquery`, and `iam-db-auth-error`.  
 **RDS for PostgreSQL**   
Possible values are `postgresql`, `upgrade`, and `iam-db-auth-error`.  
 **Aurora MySQL**   
Possible values are `audit`, `error`, `general`, `instance`, `slowquery`, and `iam-db-auth-error`.  
 **Aurora PostgreSQL**   
Possible value are `instance`, `postgresql`, and `iam-db-auth-error`.  
For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide* or [ IAM database authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EnableInternetAccessGateway **   
Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC.  
This parameter must be used together with `EnableVPCNetworking` set to `false`. When both parameters are specified, IAM database authentication is required. You must also specify `EnableIAMDatabaseAuthentication`.  
Valid for Cluster Type: Aurora PostgreSQL clusters  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to turn on Performance Insights for the DB cluster.  
Type: Boolean  
Required: No

 ** EnableVPCNetworking **   
Specifies whether to enable VPC networking for the restored DB cluster. Set this parameter to `false` to create a cluster without the VPC network interface (ENI).  
This parameter must be used together with `EnableInternetAccessGateway`. When both parameters are specified, IAM database authentication is required. You must also specify `EnableIAMDatabaseAuthentication`.  
Valid for Cluster Type: Aurora PostgreSQL clusters  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB cluster.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:  
+ Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* 
+ Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* 
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineMode **   
The DB engine mode of the DB cluster, either `provisioned` or `serverless`.  
For more information, see [ CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** EngineVersion **   
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the AWS Region is used.  
To list all of the available engine versions for Aurora MySQL, use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for Aurora PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for MySQL, use the following command:  
 `aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`   
To list all of the available engine versions for RDS for PostgreSQL, use the following command:  
 `aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`   
 **Aurora MySQL**   
See [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.  
 **Aurora PostgreSQL**   
See [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.  
 **MySQL**   
See [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*   
 **PostgreSQL**   
See [Amazon RDS for PostgreSQL versions and extensions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide.*   
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.  
For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.  
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
When you don't specify a value for the `KmsKeyId` parameter, then the following occurs:  
+ If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
+ If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is `arn:aws:iam:123456789012:role/emaccess`.  
If `MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB cluster.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*   
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** OptionGroupName **   
The name of the option group to use for the restored DB cluster.  
DB clusters are associated with a default option group that can't be modified.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS issues an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the new DB cluster accepts connections.  
Constraints: This value must be `1150-65535`   
Default: The same port as the original DB cluster.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To view the time blocks available, see [ Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB cluster is publicly accessible.  
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.  
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.  
Default: The default behavior varies depending on whether `DBSubnetGroupName` is specified.  
If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** RdsCustomClusterConfiguration **   
Reserved for future use.  
Type: [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) object  
Required: No

 ** ScalingConfiguration **   
For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.  
Valid for: Aurora DB clusters only  
Type: [ScalingConfiguration](API_ScalingConfiguration.md) object  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.  
For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** StorageType **   
Specifies the storage type to be associated with the DB cluster.  
When specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.  
Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)  
Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 **Tags.Tag.N**   
The tags to be assigned to the restored DB cluster.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB cluster.  
Valid Values:   
+  `cluster-auto-backup` - The DB cluster's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of VPC security groups that the new DB cluster will belong to.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
The user already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InsufficientDBClusterCapacityFault **   
The DB cluster doesn't have enough capacity for the current operation.  
HTTP Status Code: 403

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InsufficientStorageClusterCapacity **   
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.  
HTTP Status Code: 400

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** InvalidRestoreFault **   
Cannot restore from VPC backup to non-VPC DB instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_RestoreDBClusterFromSnapshot_Examples"></a>

### Creating a new Aurora DB cluster from a snapshot
<a name="API_RestoreDBClusterFromSnapshot_Example_1"></a>

This example illustrates one usage of RestoreDBClusterFromSnapshot.

#### Sample Request
<a name="API_RestoreDBClusterFromSnapshot_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=RestoreDBClusterFromSnapshot
    &DBClusterIdentifier=sample-restored
    &Engine=aurora-mysql
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &SnapshotIdentifier=sample-snapshot-1
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230213/us-west-2/rds/aws4_request
    &X-Amz-Date=20230213T223701Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=65d0d03242d99a16ef3712142bfcd52ac63fd2f68fbb5efd7edfb1e89138da57
```

#### Sample Response
<a name="API_RestoreDBClusterFromSnapshot_Example_1_Response"></a>

```
<RestoreDBClusterFromSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBClusterFromSnapshotResult>
    <DBCluster>
      <AllocatedStorage>1</AllocatedStorage>
      <DatabaseName>sample</DatabaseName>
      <AvailabilityZones>
        <AvailabilityZone>us-west-2a</AvailabilityZone>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <AvailabilityZone>us-west-2c</AvailabilityZone>
      </AvailabilityZones>
      <PreferredBackupWindow>10:37-11:07</PreferredBackupWindow>
      <Endpoint>sample-restored.cluster-cnubrrevfka6.us-west-2.rds.amazonaws.com</Endpoint>
      <Engine>aurora-mysql</Engine>
      <ReaderEndpoint>sample-restored.cluster-ro-cnubrrevfka6.us-west-2.rds.amazonaws.com</ReaderEndpoint>
      <ReadReplicaIdentifiers/>
      <EngineVersion>8.0.mysql_aurora.3.01.0</EngineVersion>
      <MasterUsername>mymasteruser</MasterUsername>
      <DBClusterMembers/>
      <StorageEncrypted>false</StorageEncrypted>
      <DBSubnetGroup>default</DBSubnetGroup>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-178c1671</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <HostedZoneId>Z1PVIF0B346C1W</HostedZoneId>
      <Port>3306</Port>
      <PreferredMaintenanceWindow>tue:11:51-tue:12:21</PreferredMaintenanceWindow>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBClusterIdentifier>sample-restored</DBClusterIdentifier>
      <DbClusterResourceId>cluster-BOCABDT6N5UVQW273AOXAX234Y</DbClusterResourceId>
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:sample-restored</DBClusterArn>
      <Status>creating</Status>
    </DBCluster>
  </RestoreDBClusterFromSnapshotResult>
  <ResponseMetadata>
    <RequestId>955ebc45-7a02-11e6-a5e1-0785f9b8437a</RequestId>
  </ResponseMetadata>
</RestoreDBClusterFromSnapshotResponse>
```

### Creating a new Multi-AZ DB cluster from a snapshot
<a name="API_RestoreDBClusterFromSnapshot_Example_2"></a>

This example illustrates one usage of RestoreDBClusterFromSnapshot.

#### Sample Request
<a name="API_RestoreDBClusterFromSnapshot_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=RestoreDBClusterFromSnapshot
    &DBClusterIdentifier=my-multi-az-cluster
    &SnapshotIdentifier=multi-az-cluster-snap
    &Engine=mysql
    &DBClusterInstanceClass=db.r6gd.large
    &StorageType=io1
    &Iops=1000
    &PubliclyAccessible=true
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20221026/us-west-2/rds/aws4_request
    &X-Amz-Date=20221027T000254Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=65d0d03242d99a16ef3712142bfcd52ac63fd2f68fbb5efd7edfb1e89138da57
```

#### Sample Response
<a name="API_RestoreDBClusterFromSnapshot_Example_2_Response"></a>

```
<RestoreDBClusterFromSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> 
  <RestoreDBClusterFromSnapshotResult> 
    <DBCluster> 
      <CrossAccountClone>false</CrossAccountClone> 
      <AllocatedStorage>100</AllocatedStorage> 
      <DatabaseName>mydb</DatabaseName> 
      <AssociatedRoles /> 
      <AvailabilityZones> 
        <AvailabilityZone>us-west-2a</AvailabilityZone> 
        <AvailabilityZone>us-west-2b</AvailabilityZone> 
        <AvailabilityZone>us-west-2c</AvailabilityZone> 
      </AvailabilityZones> 
      <ReadReplicaIdentifiers /> 
      <Iops>1000</Iops> 
      <EngineVersion>8.0.26</EngineVersion> 
      <MasterUsername>admin</MasterUsername> 
      <DBClusterMembers> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-3</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
      </DBClusterMembers> 
      <HttpEndpointEnabled>false</HttpEndpointEnabled> 
      <Port>3306</Port> 
      <BackupRetentionPeriod>2</BackupRetentionPeriod> 
      <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId> 
      <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier> 
      <DbClusterResourceId>cluster-XZR2FQ3N4FO4I2U5GUZT64OO44</DbClusterResourceId> 
      <Status>creating</Status> 
      <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow> 
      <DeletionProtection>false</DeletionProtection> 
      <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint> 
      <EngineMode>provisioned</EngineMode> 
      <Engine>mysql</Engine> 
      <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint> 
      <PubliclyAccessible>true</PubliclyAccessible> 
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled> 
      <ClusterCreateTime>2021-10-27T00:02:56.955Z</ClusterCreateTime> 
      <MultiAZ>true</MultiAZ> 
      <DomainMemberships /> 
      <StorageEncrypted>true</StorageEncrypted> 
      <DBSubnetGroup>default</DBSubnetGroup> 
      <VpcSecurityGroups> 
        <VpcSecurityGroupMembership> 
          <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId> 
          <Status>active</Status> 
        </VpcSecurityGroupMembership> 
      </VpcSecurityGroups> 
      <TagList /> 
      <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId> 
      <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow> 
      <DBClusterParameterGroup>default.mysql8.0</DBClusterParameterGroup> 
      <StorageType>io1</StorageType> 
      <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass> 
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot> 
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn> 
    </DBCluster> 
  </RestoreDBClusterFromSnapshotResult> 
  <ResponseMetadata> 
    <RequestId>2b06bd55-7f19-43b3-bdad-cb50e4478b48</RequestId> 
  </ResponseMetadata> 
</RestoreDBClusterFromSnapshotResponse>
```

## See Also
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

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. Unless the `RestoreType` is set to `copy-on-write`, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group.

You can use the `EnableVPCNetworking` and `EnableInternetAccessGateway` parameters together to restore an Aurora PostgreSQL cluster without VPC networking and with internet-based connectivity. These two parameters must always be specified together. Set `EnableVPCNetworking` to `false` to disable the VPC network interface (ENI) for the cluster. `EnableInternetAccessGateway` enables internet-based connectivity through an internet access gateway. IAM database authentication is required and must be enabled using `EnableIAMDatabaseAuthentication`. Once the cluster is restored, you need to modify the DB cluster to update `MasterUserAuthenticationType` to `iam-db-auth`. 

**Note**  
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the `CreateDBInstance` operation 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` operation has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide*.

For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The name of the new DB cluster to be created.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: Yes

 ** BacktrackWindow **   
The target backtrack window, in seconds. To disable backtracking, set this value to 0.  
Default: 0  
Constraints:  
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only  
Type: Long  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Specify a minimum value of `1`.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Default: Uses existing setting  
Constraints:  
+ Must be a value from 1 to 35.
Type: Integer  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** DBClusterInstanceClass **   
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines.  
For the full list of DB instance classes, and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.  
Valid for: Multi-AZ DB clusters only  
Type: String  
Required: No

 ** DBClusterParameterGroupName **   
The name of the custom DB cluster parameter group to associate with this DB cluster.  
If the `DBClusterParameterGroupName` parameter is omitted, the default DB cluster parameter group for the specified engine is used.  
Constraints:  
+ If supplied, must match the name of an existing DB cluster parameter group.
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DBSubnetGroupName **   
The DB subnet group name to use for the new DB cluster.  
Constraints: If supplied, must match the name of an existing DBSubnetGroup.  
Example: `mydbsubnetgroup`   
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.  
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to be used when making API calls to the Directory Service.  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.  
 **RDS for MySQL**   
Possible values are `error`, `general`, `slowquery`, and `iam-db-auth-error`.  
 **RDS for PostgreSQL**   
Possible values are `postgresql`, `upgrade`, and `iam-db-auth-error`.  
 **Aurora MySQL**   
Possible values are `audit`, `error`, `general`, `instance`, `slowquery`, and `iam-db-auth-error`.  
 **Aurora PostgreSQL**   
Possible value are `instance`, `postgresql`, and `iam-db-auth-error`.  
For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide* or [ IAM database authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide*.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 ** EnableInternetAccessGateway **   
Specifies that the restored DB cluster should use internet-based connectivity through an internet access gateway. This allows clients to connect to the cluster over the internet without requiring a VPC.  
This parameter must be used together with `EnableVPCNetworking` set to `false`. When both parameters are specified, IAM database authentication is required. You must also specify `EnableIAMDatabaseAuthentication`.  
Valid for Cluster Type: Aurora PostgreSQL clusters  
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to turn on Performance Insights for the DB cluster.  
Type: Boolean  
Required: No

 ** EnableVPCNetworking **   
Specifies whether to enable VPC networking for the restored DB cluster. Set this parameter to `false` to create a cluster without the VPC network interface (ENI).  
This parameter must be used together with `EnableInternetAccessGateway`. When both parameters are specified, IAM database authentication is required. You must also specify `EnableIAMDatabaseAuthentication`.  
Valid for Cluster Type: Aurora PostgreSQL clusters  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB cluster.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:  
+ Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* 
+ Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* 
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineMode **   
The engine mode of the new cluster. Specify `provisioned` or `serverless`, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode `serverless`.  
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.  
For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.  
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.  
Valid for: Multi-AZ DB clusters only  
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the `KmsKeyId` parameter.  
If you don't specify a value for the `KmsKeyId` parameter, then the following occurs:  
+ If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
+ If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If `DBClusterIdentifier` refers to a DB cluster that isn't encrypted, then the restore request is rejected.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify `0`.  
If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.  
Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`   
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is `arn:aws:iam:123456789012:role/emaccess`.  
If `MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.  
Type: String  
Required: No

 ** NetworkType **   
The network type of the DB cluster.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*   
Valid for: Aurora DB clusters only  
Type: String  
Required: No

 ** OptionGroupName **   
The name of the option group for the new DB cluster.  
DB clusters are associated with a default option group that can't be modified.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data.  
Valid Values:  
+  `7` 
+  *month* \$1 31, where *month* is a number of months from 1-23. Examples: `93` (3 months \$1 31), `341` (11 months \$1 31), `589` (19 months \$1 31)
+  `731` 
Default: `7` days  
If you specify a retention period that isn't valid, such as `94`, Amazon RDS issues an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the new DB cluster accepts connections.  
Constraints: A value from `1150-65535`.  
Default: The default port for the engine.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To view the time blocks available, see [ Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide*.  
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB cluster is publicly accessible.  
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.  
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.  
Default: The default behavior varies depending on whether `DBSubnetGroupName` is specified.  
If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:  
+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only  
Type: Boolean  
Required: No

 ** RdsCustomClusterConfiguration **   
Reserved for future use.  
Type: [RdsCustomClusterConfiguration](API_RdsCustomClusterConfiguration.md) object  
Required: No

 ** RestoreToTime **   
The date and time to restore the DB cluster to.  
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format  
Constraints:  
+ Must be before the latest restorable time for the DB instance
+ Must be specified if `UseLatestRestorableTime` parameter isn't provided
+ Can't be specified if the `UseLatestRestorableTime` parameter is enabled
+ Can't be specified if the `RestoreType` parameter is `copy-on-write` 
Example: `2015-03-07T23:45:00Z`   
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Timestamp  
Required: No

 ** RestoreType **   
The type of restore to be performed. You can specify one of the following values:  
+  `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.
+  `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** ScalingConfiguration **   
For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.  
Valid for: Aurora DB clusters only  
Type: [ScalingConfiguration](API_ScalingConfiguration.md) object  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.  
For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** SourceDBClusterIdentifier **   
The identifier of the source DB cluster from which to restore.  
Constraints:  
+ Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 ** SourceDbClusterResourceId **   
The resource ID of the source DB cluster from which to restore.  
Type: String  
Required: No

 ** StorageType **   
Specifies the storage type to be associated with the DB cluster.  
When specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.  
Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)  
Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB cluster.  
Valid Values:   
+  `cluster-auto-backup` - The DB cluster's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** UseLatestRestorableTime **   
Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.  
Constraints: Can't be specified if `RestoreToTime` parameter is provided.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of VPC security groups that the new DB cluster belongs to.  
Valid for: Aurora DB clusters and Multi-AZ DB clusters  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
The user already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterAutomatedBackupNotFoundFault **   
No automated backup for this DB cluster was found.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` doesn't refer to an existing DB cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InsufficientDBClusterCapacityFault **   
The DB cluster doesn't have enough capacity for the current operation.  
HTTP Status Code: 403

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InsufficientStorageClusterCapacity **   
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.  
HTTP Status Code: 400

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value isn't a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** InvalidRestoreFault **   
Cannot restore from VPC backup to non-VPC DB instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_RestoreDBClusterToPointInTime_Examples"></a>

### Restoring an Aurora DB cluster to a point in time
<a name="API_RestoreDBClusterToPointInTime_Example_1"></a>

This example illustrates one usage of RestoreDBClusterToPointInTime.

#### Sample Request
<a name="API_RestoreDBClusterToPointInTime_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=RestoreDBClusterToPointInTime
    &DBClusterIdentifier=sample-restored-1
    &RestoreToTime=2023-02-13T18%3A45%3A00Z
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &SourceDBClusterIdentifier=sample-cluster
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20230213/us-west-2/rds/aws4_request
    &X-Amz-Date=20230213T224930Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=e3b88945052247e82eaeaca6e269e7f6e18a36147b45c3b077bc600472e70de6
```

#### Sample Response
<a name="API_RestoreDBClusterToPointInTime_Example_1_Response"></a>

```
<RestoreDBClusterToPointInTimeResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBClusterToPointInTimeResult>
    <DBCluster>
      <AllocatedStorage>1</AllocatedStorage>
      <DatabaseName>sample</DatabaseName>
      <AvailabilityZones>
        <AvailabilityZone>us-west-2a</AvailabilityZone>
        <AvailabilityZone>us-west-2b</AvailabilityZone>
        <AvailabilityZone>us-west-2c</AvailabilityZone>
      </AvailabilityZones>
      <PreferredBackupWindow>10:37-11:07</PreferredBackupWindow>
      <Endpoint>sample-restored-1.cluster-cnubrrfwfkg6.us-west-2.rds.amazonaws.com</Endpoint>
      <Engine>aurora-mysql</Engine>
      <ReaderEndpoint>sample-restored-1.cluster-ro-cnubrrfwfkg6.us-west-2.rds.amazonaws.com</ReaderEndpoint>
      <ReadReplicaIdentifiers/>
      <EngineVersion>8.0.mysql_aurora.3.01.0</EngineVersion>
      <MasterUsername>mymasteruser</MasterUsername>
      <DBClusterMembers/>
      <StorageEncrypted>false</StorageEncrypted>
      <DBSubnetGroup>default</DBSubnetGroup>
      <HostedZoneId>Z1PVIF0B622C1W</HostedZoneId>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-187c1671</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <Port>3306</Port>
      <PreferredMaintenanceWindow>tue:11:51-tue:12:21</PreferredMaintenanceWindow>
      <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBClusterIdentifier>sample-restored-1</DBClusterIdentifier>
      <DbClusterResourceId>cluster-U5ZXU3237H7YVCVKISDIXSQKUQ</DbClusterResourceId>
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:sample-restored-1</DBClusterArn>
      <Status>creating</Status>
    </DBCluster>
  </RestoreDBClusterToPointInTimeResult>
  <ResponseMetadata>
    <RequestId>54b75eef-7a04-15b6-aaa0-75ef834084a0</RequestId>
  </ResponseMetadata>
</RestoreDBClusterToPointInTimeResponse>
```

### Restoring a Multi-AZ DB cluster to a point in time
<a name="API_RestoreDBClusterToPointInTime_Example_2"></a>

This example illustrates one usage of RestoreDBClusterToPointInTime.

#### Sample Request
<a name="API_RestoreDBClusterToPointInTime_Example_2_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
    ?Action=RestoreDBClusterToPointInTime
    &DBClusterIdentifier=my-multi-az-cluster-pit
    &SourceDBClusterIdentifier=my-multi-az-cluster
    &UseLatestRestorableTime=true
    &DBClusterInstanceClass=db.r6gd.large
    &StorageType=io1
    &Iops=1000
    &PubliclyAccessible=true
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20221026/us-west-2/rds/aws4_request
    &X-Amz-Date=20221027T000601Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=e3b88945052247e82eaeaca6e269e7f6e18a36147b45c3b077bc600472e70de6
```

#### Sample Response
<a name="API_RestoreDBClusterToPointInTime_Example_2_Response"></a>

```
<RestoreDBClusterToPointInTimeResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> 
  <RestoreDBClusterToPointInTimeResult> 
    <DBCluster> 
      <CrossAccountClone>false</CrossAccountClone> 
      <AllocatedStorage>100</AllocatedStorage> 
      <DatabaseName>mydb</DatabaseName> 
      <AssociatedRoles /> 
      <AvailabilityZones> 
        <AvailabilityZone>us-west-2a</AvailabilityZone> 
        <AvailabilityZone>us-west-2b</AvailabilityZone> 
        <AvailabilityZone>us-west-2d</AvailabilityZone> 
      </AvailabilityZones> 
      <ReadReplicaIdentifiers /> 
      <Iops>1000</Iops> 
      <EngineVersion>8.0.26</EngineVersion> 
      <MasterUsername>admin</MasterUsername> 
      <DBClusterMembers> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-3</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
        <DBClusterMember> 
          <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier> 
          <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> 
          <PromotionTier>1</PromotionTier> 
          <IsClusterWriter>false</IsClusterWriter> 
        </DBClusterMember> 
      </DBClusterMembers> 
      <HttpEndpointEnabled>false</HttpEndpointEnabled> 
      <Port>3306</Port> 
      <BackupRetentionPeriod>2</BackupRetentionPeriod> 
      <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId> 
      <DBClusterIdentifier>my-multi-az-cluster-pit</DBClusterIdentifier> 
      <DbClusterResourceId>cluster-SA2CL64NMV4KTUP6PI4TJWLOM4</DbClusterResourceId> 
      <Status>creating</Status> 
      <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow> 
      <DeletionProtection>false</DeletionProtection> 
      <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint> 
      <EngineMode>provisioned</EngineMode> 
      <Engine>mysql</Engine> 
      <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint> 
      <PubliclyAccessible>true</PubliclyAccessible> 
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled> 
      <ClusterCreateTime>2021-10-27T00:06:04.033Z</ClusterCreateTime> 
      <MultiAZ>true</MultiAZ> 
      <DomainMemberships /> 
      <StorageEncrypted>true</StorageEncrypted> 
      <DBSubnetGroup>default</DBSubnetGroup> 
      <VpcSecurityGroups> 
        <VpcSecurityGroupMembership> 
          <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId> 
          <Status>active</Status> 
        </VpcSecurityGroupMembership> 
      </VpcSecurityGroups> 
      <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId> 
      <TagList /> 
      <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow> 
      <DBClusterParameterGroup>my-cluster-param-1</DBClusterParameterGroup> 
      <StorageType>io1</StorageType> 
      <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass> 
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot> 
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
      <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn> 
    </DBCluster> 
  </RestoreDBClusterToPointInTimeResult> 
  <ResponseMetadata> 
    <RequestId>ec5c848f-3f6a-4c98-9b45-2da58c4e4a96</RequestId> 
  </ResponseMetadata> 
</RestoreDBClusterToPointInTimeResponse>
```

## See Also
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBClusterToPointInTime) 

# RestoreDBInstanceFromDBSnapshot
<a name="API_RestoreDBInstanceFromDBSnapshot"></a>

Creates 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, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the `RestoreDBInstanceFromDBSnapshot` operation. RDS doesn't allow two DB instances with the same name. After 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` operation. The result is that you 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.

To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see [Upgrading a MySQL DB snapshot engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html). For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, [Upgrading a PostgreSQL DB snapshot engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html).

**Note**  
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use `RestoreDBClusterFromSnapshot`.

## Request Parameters
<a name="API_RestoreDBInstanceFromDBSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.  
Constraints:  
+ Must contain from 1 to 63 numbers, letters, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `my-snapshot-id`   
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.  
This setting isn't valid for RDS for SQL Server.  
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.  
If you restore an RDS Custom DB instance, you must disable this parameter.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AvailabilityZone **   
The Availability Zone (AZ) where the DB instance will be created.  
Default: A random, system-chosen Availability Zone.  
Constraint: You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.  
Example: `us-east-1a`   
Type: String  
Required: No

 ** BackupRetentionPeriod **   
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.  
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Default: Uses existing setting  
Constraints:  
+ Must be a value from 0 to 35.
+ Can't be set to 0 if the DB instance is a source to read replicas.
+ Can't be set to 0 for an RDS Custom for Oracle DB instance.
Type: Integer  
Required: No

 ** BackupTarget **   
Specifies where automated backups and manual snapshots are stored for the restored DB instance.  
Possible values are `local` (Dedicated Local Zone), `outposts` (AWS Outposts), and `region` (AWS Region). The default is `region`.  
For more information, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB instance's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.  
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.  
For more information, see [ Copying tags to DB instance snapshots](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags) in the *Amazon RDS User Guide*.  
Type: Boolean  
Required: No

 ** CustomIamInstanceProfile **   
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:  
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`.
For the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.  
This setting is required for RDS Custom.  
Type: String  
Required: No

 ** DBClusterSnapshotIdentifier **   
The identifier for the Multi-AZ DB cluster snapshot to restore from.  
For more information on Multi-AZ DB clusters, see [ Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.  
Constraints:  
+ Must match the identifier of an existing Multi-AZ DB cluster snapshot.
+ Can't be specified when `DBSnapshotIdentifier` is specified.
+ Must be specified when `DBSnapshotIdentifier` isn't specified.
+ If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot.
+ Can't be the identifier of an Aurora DB cluster snapshot.
Type: String  
Required: No

 ** DBInstanceClass **   
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.*   
Default: The same DBInstanceClass as the original DB instance.  
Type: String  
Required: No

 ** DBName **   
The name of the database for the restored DB instance.  
This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.  
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to associate with this DB instance.  
If you don't specify a value for `DBParameterGroupName`, then RDS uses the default `DBParameterGroup` for the specified DB engine.  
This setting doesn't apply to RDS Custom.  
Constraints:  
+ If supplied, must match the name of an existing DB parameter group.
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: No

 ** DBSnapshotIdentifier **   
The identifier for the DB snapshot to restore from.  
Constraints:  
+ Must match the identifier of an existing DB snapshot.
+ Can't be specified when `DBClusterSnapshotIdentifier` is specified.
+ Must be specified when `DBClusterSnapshotIdentifier` isn't specified.
+ If you are restoring from a shared manual DB snapshot, the `DBSnapshotIdentifier` must be the ARN of the shared DB snapshot.
Type: String  
Required: No

 ** DBSubnetGroupName **   
The name of the DB subnet group to use for the new instance.  
Constraints:  
+ If supplied, must match the name of an existing DB subnet group.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DedicatedLogVolume **   
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** DomainAuthSecretArn **   
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`   
Type: String  
Required: No

 **DomainDnsIps.member.N**   
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.  
Constraints:  
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: `123.124.125.126,234.235.236.237`   
Type: Array of strings  
Required: No

 ** DomainFqdn **   
The fully qualified domain name (FQDN) of an Active Directory domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `mymanagedADtest.mymanagedAD.mydomain`   
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainOu **   
The Active Directory organizational unit for your DB instance to join.  
Constraints:  
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.
Example: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`   
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom.  
Type: Array of strings  
Required: No

 ** EnableCustomerOwnedIp **   
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.  
A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.  
This setting doesn't apply to RDS Custom.  
For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*.  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.  
For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*   
This setting doesn't apply to RDS Custom.  
Type: Boolean  
Required: No

 ** Engine **   
The database engine to use for the new instance.  
This setting doesn't apply to RDS Custom.  
Default: The same as source  
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.  
Valid Values:  
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Type: String  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB instance.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.  
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** Iops **   
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.  
The provisioned IOPS value must follow the requirements for your database engine. For more information, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide.*   
Constraints: Must be an integer greater than 1000.  
Type: Integer  
Required: No

 ** LicenseModel **   
License model information for the restored DB instance.  
License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an AWS License Manager self-managed license. The Db2 license through AWS Marketplace model requires an AWS Marketplace subscription. For more information, see [Amazon RDS for Db2 licensing options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Valid Values:  
+ RDS for Db2 - `bring-your-own-license | marketplace-license` 
+ RDS for MariaDB - `general-public-license` 
+ RDS for Microsoft SQL Server - `license-included` 
+ RDS for MySQL - `general-public-license` 
+ RDS for Oracle - `bring-your-own-license | license-included` 
+ RDS for PostgreSQL - `postgresql-license` 
Default: Same as the source.  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager in the restored DB instance.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide*.  
Constraints:  
+ Applies to RDS for Oracle only.
Type: Boolean  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** MultiAZ **   
Specifies whether the DB instance is a Multi-AZ deployment.  
This setting doesn't apply to RDS Custom.  
Constraint: You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.  
Type: Boolean  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Type: String  
Required: No

 ** OptionGroupName **   
The name of the option group to be used for the restored DB instance.  
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** Port **   
The port number on which the database accepts connections.  
Default: The same port as the original DB instance  
Constraints: Value must be `1150-65535`   
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information, see [Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
This setting doesn't apply to RDS Custom.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBInstance](API_CreateDBInstance.md).  
Type: Boolean  
Required: No

 ** StorageThroughput **   
Specifies the storage throughput value for the DB instance.  
This setting doesn't apply to RDS Custom or Amazon Aurora.  
Type: Integer  
Required: No

 ** StorageType **   
Specifies the storage type to be associated with the DB instance.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
If you specify `io1`, `io2`, or `gp3`, you must also include a value for the `Iops` parameter.  
Default: `io1` if the `Iops` parameter is specified, otherwise `gp3`   
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** TdeCredentialArn **   
The ARN from the key store with which to associate the instance for TDE encryption.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** TdeCredentialPassword **   
The password for the given ARN from the key store in order to access the device.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** UseDefaultProcessorFeatures **   
Specifies whether the DB instance class of the DB instance uses its default processor features.  
This setting doesn't apply to RDS Custom.  
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of EC2 VPC security groups to associate with this DB instance.  
Default: The default EC2 VPC security group for the DB subnet group's VPC.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBInstanceFromDBSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_RestoreDBInstanceFromDBSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** BackupPolicyNotFoundFault **   
 *This error has been deprecated.*   
  
HTTP Status Code: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBSnapshotState **   
The state of the DB snapshot doesn't allow deletion.  
HTTP Status Code: 400

 ** InvalidRestoreFault **   
Cannot restore from VPC backup to non-VPC DB instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_RestoreDBInstanceFromDBSnapshot_Examples"></a>

### Example
<a name="API_RestoreDBInstanceFromDBSnapshot_Example_1"></a>

This example illustrates one usage of RestoreDBInstanceFromDBSnapshot.

#### Sample Request
<a name="API_RestoreDBInstanceFromDBSnapshot_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=RestoreDBInstanceFromDBSnapshot
   &DBInstanceIdentifier=mysqldb-restored
   &DBSnapshotIdentifier=rds%3Amysqldb-2014-04-22-08-15
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T232655Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=78ac761e8c8f54a8c0727f4e67ad0a766fbb0024510b9aa34ea6d1f7df52fe92
```

#### Sample Response
<a name="API_RestoreDBInstanceFromDBSnapshot_Example_1_Response"></a>

```
<RestoreDBInstanceFromDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBInstanceFromDBSnapshotResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <MultiAZ>false</MultiAZ>
      <DBInstanceStatus>creating</DBInstanceStatus>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mysqldb-restored</DBInstanceIdentifier>
      <PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <ReadReplicaDBInstanceIdentifiers/>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>pending-apply</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>mysqldb</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
    </DBInstance>
  </RestoreDBInstanceFromDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>863fd73e-be2b-11d3-855b-576787000e19</RequestId>
  </ResponseMetadata>
</RestoreDBInstanceFromDBSnapshotResponse>
```

## See Also
<a name="API_RestoreDBInstanceFromDBSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot) 

# RestoreDBInstanceFromS3
<a name="API_RestoreDBInstanceFromS3"></a>

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see [Restoring a backup into an Amazon RDS for MySQL DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html) in the *Amazon RDS User Guide.* 

This operation doesn't apply to RDS Custom.

## Request Parameters
<a name="API_RestoreDBInstanceFromS3_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceClass **   
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.*   
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.  
Type: String  
Required: Yes

 ** DBInstanceIdentifier **   
The DB instance identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Example: `mydbinstance`   
Type: String  
Required: Yes

 ** Engine **   
The name of the database engine to be used for this instance.  
Valid Values: `mysql`   
Type: String  
Required: Yes

 ** S3BucketName **   
The name of your Amazon S3 bucket that contains your database backup file.  
Type: String  
Required: Yes

 ** S3IngestionRoleArn **   
An AWS Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see [ Creating an IAM role manually](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html#MySQL.Procedural.Importing.Enabling.IAM) in the *Amazon RDS User Guide.*   
Type: String  
Required: Yes

 ** SourceEngine **   
The name of the engine of your source database.  
Valid Values: `mysql`   
Type: String  
Required: Yes

 ** SourceEngineVersion **   
The version of the database that the backup files were created from.  
MySQL versions 5.6 and 5.7 are supported.  
Example: `5.6.40`   
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to modify or delete for the DB instance. You can modify or delete up to three additional storage volumes using the names `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in `CreateDBInstance`.  
This setting isn't valid for RDS for SQL Server.  
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AvailabilityZone **   
The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon RDS User Guide.*   
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.  
Example: `us-east-1d`   
Constraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.  
Type: String  
Required: No

 ** BackupRetentionPeriod **   
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see `CreateDBInstance`.  
Type: Integer  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB instance's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.  
Type: Boolean  
Required: No

 ** DatabaseInsightsMode **   
Specifies the mode of Database Insights to enable for the DB instance.  
Aurora DB instances inherit this value from the DB cluster, so you can't change this value.
Type: String  
Valid Values: `standard | advanced`   
Required: No

 ** DBName **   
The name of the database to create when the DB instance is created. Follow the naming rules specified in `CreateDBInstance`.  
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to associate with this DB instance.  
If you do not specify a value for `DBParameterGroupName`, then the default `DBParameterGroup` for the specified DB engine is used.  
Type: String  
Required: No

 **DBSecurityGroups.DBSecurityGroupName.N**   
A list of DB security groups to associate with this DB instance.  
Default: The default DB security group for the database engine.  
Type: Array of strings  
Required: No

 ** DBSubnetGroupName **   
A DB subnet group to associate with this DB instance.  
Constraints: If supplied, must match the name of an existing DBSubnetGroup.  
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DedicatedLogVolume **   
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
Type: Boolean  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
Type: Array of strings  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*   
Type: Boolean  
Required: No

 ** EnablePerformanceInsights **   
Specifies whether to enable Performance Insights for the DB instance.  
For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.  
Type: Boolean  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB instance.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.  
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** EngineVersion **   
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.  
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide.*   
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for an encrypted DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If the `StorageEncrypted` parameter is enabled, and you do not specify a value for the `KmsKeyId` parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** LicenseModel **   
The license model for this DB instance. Use `general-public-license`.  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*   
Constraints:  
+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
Type: Boolean  
Required: No

 ** MasterUsername **   
The name for the master user.  
Constraints:  
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
Type: String  
Required: No

 ** MasterUserPassword **   
The password for the master user.  
Constraints:  
+ Can't be specified if `ManageMasterUserPassword` is turned on.
+ Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:  
+ RDS for Db2 - Must contain from 8 to 128 characters.
+ RDS for MariaDB - Must contain from 8 to 41 characters.
+ RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
+ RDS for MySQL - Must contain from 8 to 41 characters.
+ RDS for Oracle - Must contain from 8 to 30 characters.
+ RDS for PostgreSQL - Must contain from 8 to 128 characters.
Type: String  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** MaxAllocatedStorage **   
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.  
For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.  
Type: Integer  
Required: No

 ** MonitoringInterval **   
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.  
If `MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0.  
Valid Values: 0, 1, 5, 10, 15, 30, 60  
Default: `0`   
Type: Integer  
Required: No

 ** MonitoringRoleArn **   
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide.*   
If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.  
Type: String  
Required: No

 ** MultiAZ **   
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the `AvailabilityZone` parameter.  
Type: Boolean  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
Valid Values:  
+  `IPV4` 
+  `DUAL` 
The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Type: String  
Required: No

 ** OptionGroupName **   
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.  
Type: String  
Required: No

 ** PerformanceInsightsKMSKeyId **   
The AWS KMS key identifier for encryption of Performance Insights data.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
If you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** PerformanceInsightsRetentionPeriod **   
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:  
+ 7
+  *month* \$1 31, where *month* is a number of months from 1-23
+ 731
For example, the following values are valid:  
+ 93 (3 months \$1 31)
+ 341 (11 months \$1 31)
+ 589 (19 months \$1 31)
+ 731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.  
Type: Integer  
Required: No

 ** Port **   
The port number on which the database accepts connections.  
Type: Integer  
Valid Values: `1150`-`65535`   
Default: `3306`   
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The time range each day during which automated backups are created if automated backups are enabled. For more information, see [Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*   
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see [Amazon RDS Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) in the *Amazon RDS User Guide.*   
Constraints:  
+ Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
+ Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred backup window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBInstance](API_CreateDBInstance.md).  
Type: Boolean  
Required: No

 ** S3Prefix **   
The prefix of your Amazon S3 bucket.  
Type: String  
Required: No

 ** StorageEncrypted **   
Specifies whether the new DB instance is encrypted or not.  
Type: Boolean  
Required: No

 ** StorageThroughput **   
Specifies the storage throughput value for the DB instance.  
This setting doesn't apply to RDS Custom or Amazon Aurora.  
Type: Integer  
Required: No

 ** StorageType **   
Specifies the storage type to be associated with the DB instance.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
If you specify `io1`, `io2`, or `gp3`, you must also include a value for the `Iops` parameter.  
Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`   
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to associate with this DB instance. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** UseDefaultProcessorFeatures **   
Specifies whether the DB instance class of the DB instance uses its default processor features.  
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of VPC security groups to associate with this DB instance.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBInstanceFromS3_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_RestoreDBInstanceFromS3_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** BackupPolicyNotFoundFault **   
 *This error has been deprecated.*   
  
HTTP Status Code: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidS3BucketFault **   
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the **SourceS3BucketName** and **S3IngestionRoleArn** values and try again.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreDBInstanceFromS3_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBInstanceFromS3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBInstanceFromS3) 

# RestoreDBInstanceToPointInTime
<a name="API_RestoreDBInstanceToPointInTime"></a>

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the `LatestRestorableTime` property. You can restore to a point up to the number of days specified by the `BackupRetentionPeriod` property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

**Note**  
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use `RestoreDBClusterToPointInTime`.

## Request Parameters
<a name="API_RestoreDBInstanceToPointInTime_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** TargetDBInstanceIdentifier **   
The name of the new DB instance to create.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: Yes

 **AdditionalStorageVolumes.member.N**   
A list of additional storage volumes to restore to the DB instance. You can restore up to three additional storage volumes using the names `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.  
Type: Array of [AdditionalStorageVolume](API_AdditionalStorageVolume.md) objects  
Required: No

 ** AllocatedStorage **   
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in `CreateDBInstance`.  
This setting isn't valid for RDS for SQL Server.  
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Type: Integer  
Required: No

 ** AutoMinorVersionUpgrade **   
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.  
This setting doesn't apply to RDS Custom.  
For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).  
Type: Boolean  
Required: No

 ** AvailabilityZone **   
The Availability Zone (AZ) where the DB instance will be created.  
Default: A random, system-chosen Availability Zone.  
Constraints:  
+ You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.
Example: `us-east-1a`   
Type: String  
Required: No

 ** BackupRetentionPeriod **   
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.  
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Default: Uses existing setting  
Constraints:  
+ Must be a value from 0 to 35.
+ Can't be set to 0 if the DB instance is a source to read replicas.
+ Can't be set to 0 for an RDS Custom for Oracle DB instance.
Type: Integer  
Required: No

 ** BackupTarget **   
The location for storing automated backups and manual snapshots for the restored DB instance.  
Valid Values:  
+  `local` (Dedicated Local Zone)
+  `outposts` (AWS Outposts)
+  `region` (AWS Region)
Default: `region`   
For more information, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** CACertificateIdentifier **   
The CA certificate identifier to use for the DB instance's server certificate.  
This setting doesn't apply to RDS Custom DB instances.  
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.  
Type: String  
Required: No

 ** CopyTagsToSnapshot **   
Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.  
Type: Boolean  
Required: No

 ** CustomIamInstanceProfile **   
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:  
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`.
For the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.  
This setting is required for RDS Custom.  
Type: String  
Required: No

 ** DBInstanceClass **   
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.  
Default: The same DB instance class as the original DB instance.  
Type: String  
Required: No

 ** DBName **   
The database name for the restored DB instance.  
This parameter doesn't apply to the following DB instances:  
+ RDS Custom
+ RDS for Db2
+ RDS for MariaDB
+ RDS for MySQL
Type: String  
Required: No

 ** DBParameterGroupName **   
The name of the DB parameter group to associate with this DB instance.  
If you do not specify a value for `DBParameterGroupName`, then the default `DBParameterGroup` for the specified DB engine is used.  
This setting doesn't apply to RDS Custom.  
Constraints:  
+ If supplied, must match the name of an existing DB parameter group.
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: No

 ** DBSubnetGroupName **   
The DB subnet group name to use for the new instance.  
Constraints:  
+ If supplied, must match the name of an existing DB subnet group.
Example: `mydbsubnetgroup`   
Type: String  
Required: No

 ** DedicatedLogVolume **   
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.  
Type: Boolean  
Required: No

 ** DeletionProtection **   
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).  
Type: Boolean  
Required: No

 ** Domain **   
The Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.  
This setting doesn't apply to RDS Custom.  
For more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.  
Type: String  
Required: No

 ** DomainAuthSecretArn **   
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`   
Type: String  
Required: No

 **DomainDnsIps.member.N**   
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.  
Constraints:  
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: `123.124.125.126,234.235.236.237`   
Type: Array of strings  
Required: No

 ** DomainFqdn **   
The fully qualified domain name (FQDN) of an Active Directory domain.  
Constraints:  
+ Can't be longer than 64 characters.
Example: `mymanagedADtest.mymanagedAD.mydomain`   
Type: String  
Required: No

 ** DomainIAMRoleName **   
The name of the IAM role to use when making API calls to the Directory Service.  
This setting doesn't apply to RDS Custom DB instances.  
Type: String  
Required: No

 ** DomainOu **   
The Active Directory organizational unit for your DB instance to join.  
Constraints:  
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.
Example: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`   
Type: String  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom.  
Type: Array of strings  
Required: No

 ** EnableCustomerOwnedIp **   
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.  
A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.  
This setting doesn't apply to RDS Custom.  
For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*.  
For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the * AWS Outposts User Guide*.  
Type: Boolean  
Required: No

 ** EnableIAMDatabaseAuthentication **   
Specifies whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.  
This setting doesn't apply to RDS Custom.  
For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*   
Type: Boolean  
Required: No

 ** Engine **   
The database engine to use for the new instance.  
This setting doesn't apply to RDS Custom.  
Valid Values:  
+  `db2-ae` 
+  `db2-se` 
+  `mariadb` 
+  `mysql` 
+  `oracle-ee` 
+  `oracle-ee-cdb` 
+  `oracle-se2` 
+  `oracle-se2-cdb` 
+  `postgres` 
+  `sqlserver-ee` 
+  `sqlserver-se` 
+  `sqlserver-ex` 
+  `sqlserver-web` 
Default: The same as source  
Constraints:  
+ Must be compatible with the engine of the source.
Type: String  
Required: No

 ** EngineLifecycleSupport **   
The life cycle type for this DB instance.  
By default, this value is set to `open-source-rds-extended-support`, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.  
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.  
Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`   
Default: `open-source-rds-extended-support`   
Type: String  
Required: No

 ** Iops **   
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.  
This setting doesn't apply to SQL Server.  
Constraints:  
+ Must be an integer greater than 1000.
Type: Integer  
Required: No

 ** LicenseModel **   
The license model information for the restored DB instance.  
License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an AWS License Manager self-managed license. The Db2 license through AWS Marketplace model requires an AWS Marketplace subscription. For more information, see [Amazon RDS for Db2 licensing options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.  
Valid Values:  
+ RDS for Db2 - `bring-your-own-license | marketplace-license` 
+ RDS for MariaDB - `general-public-license` 
+ RDS for Microsoft SQL Server - `license-included` 
+ RDS for MySQL - `general-public-license` 
+ RDS for Oracle - `bring-your-own-license | license-included` 
+ RDS for PostgreSQL - `postgresql-license` 
Default: Same as the source.  
Type: String  
Required: No

 ** ManageMasterUserPassword **   
Specifies whether to manage the master user password with AWS Secrets Manager in the restored DB instance.  
For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide*.  
Constraints:  
+ Applies to RDS for Oracle only.
Type: Boolean  
Required: No

 ** MasterUserSecretKmsKeyId **   
The AWS KMS key identifier to encrypt a secret that is automatically generated and managed in AWS Secrets Manager.  
This setting is valid only if the master user password is managed by RDS in AWS Secrets Manager for the DB instance.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different AWS account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different AWS account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.  
Type: String  
Required: No

 ** MaxAllocatedStorage **   
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.  
For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.  
This setting doesn't apply to RDS Custom.  
Type: Integer  
Required: No

 ** MultiAZ **   
Secifies whether the DB instance is a Multi-AZ deployment.  
This setting doesn't apply to RDS Custom.  
Constraints:  
+ You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.
Type: Boolean  
Required: No

 ** NetworkType **   
The network type of the DB instance.  
The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*   
Valid Values:  
+  `IPV4` 
+  `DUAL` 
Type: String  
Required: No

 ** OptionGroupName **   
The name of the option group to use for the restored DB instance.  
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** Port **   
The port number on which the database accepts connections.  
Default: The same port as the original DB instance.  
Constraints:  
+ The value must be `1150-65535`.
Type: Integer  
Required: No

 ** PreferredBackupWindow **   
The daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information, see [Backup window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide*.  
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see `ModifyDBCluster`.  
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String  
Required: No

 **ProcessorFeatures.ProcessorFeature.N**   
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.  
This setting doesn't apply to RDS Custom.  
Type: Array of [ProcessorFeature](API_ProcessorFeature.md) objects  
Required: No

 ** PubliclyAccessible **   
Specifies whether the DB instance is publicly accessible.  
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
For more information, see [CreateDBInstance](API_CreateDBInstance.md).  
Type: Boolean  
Required: No

 ** RestoreTime **   
The date and time to restore from.  
Constraints:  
+ Must be a time in Universal Coordinated Time (UTC) format.
+ Must be before the latest restorable time for the DB instance.
+ Can't be specified if the `UseLatestRestorableTime` parameter is enabled.
Example: `2009-09-07T23:45:00Z`   
Type: Timestamp  
Required: No

 ** SourceDBInstanceAutomatedBackupsArn **   
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** SourceDBInstanceIdentifier **   
The identifier of the source DB instance from which to restore.  
Constraints:  
+ Must match the identifier of an existing DB instance.
Type: String  
Required: No

 ** SourceDbiResourceId **   
The resource ID of the source DB instance from which to restore.  
Type: String  
Required: No

 ** StorageThroughput **   
The storage throughput value for the DB instance.  
This setting doesn't apply to RDS Custom or Amazon Aurora.  
Type: Integer  
Required: No

 ** StorageType **   
The storage type to associate with the DB instance.  
Valid Values: `gp2 | gp3 | io1 | io2 | standard`   
Default: `io1`, if the `Iops` parameter is specified. Otherwise, `gp3`.  
Constraints:  
+ If you specify `io1`, `io2`, or `gp3`, you must also include a value for the `Iops` parameter.
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags.  
For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **TagSpecifications.item.N**   
Tags to assign to resources associated with the DB instance.  
Valid Values:   
+  `auto-backup` - The DB instance's automated backup.
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** TdeCredentialArn **   
The ARN from the key store with which to associate the instance for TDE encryption.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** TdeCredentialPassword **   
The password for the given ARN from the key store in order to access the device.  
This setting doesn't apply to RDS Custom.  
Type: String  
Required: No

 ** UseDefaultProcessorFeatures **   
Specifies whether the DB instance class of the DB instance uses its default processor features.  
This setting doesn't apply to RDS Custom.  
Type: Boolean  
Required: No

 ** UseLatestRestorableTime **   
Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.  
Constraints:  
+ Can't be specified if the `RestoreTime` parameter is provided.
Type: Boolean  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of EC2 VPC security groups to associate with this DB instance.  
Default: The default EC2 VPC security group for the DB subnet group's VPC.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBInstanceToPointInTime_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_RestoreDBInstanceToPointInTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** BackupPolicyNotFoundFault **   
 *This error has been deprecated.*   
  
HTTP Status Code: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` doesn't refer to an existing certificate.  
HTTP Status Code: 404

 ** DBInstanceAlreadyExists **   
The user already has a DB instance with the given identifier.  
HTTP Status Code: 400

 ** DBInstanceAutomatedBackupNotFound **   
No automated backup for this DB instance was found.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` doesn't refer to an existing DB parameter group.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DomainNotFoundFault **   
 `Domain` doesn't refer to an existing Active Directory domain.  
HTTP Status Code: 404

 ** InstanceQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB instances.  
HTTP Status Code: 400

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidRestoreFault **   
Cannot restore from VPC backup to non-VPC DB instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** NetworkTypeNotSupported **   
The network type is invalid for the DB instance. Valid nework type values are `IPV4` and `DUAL`.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The specified option group could not be found.  
HTTP Status Code: 404

 ** PointInTimeRestoreNotEnabled **   
 `SourceDBInstanceIdentifier` refers to a DB instance with `BackupRetentionPeriod` equal to 0.  
HTTP Status Code: 400

 ** ProvisionedIopsNotAvailableInAZFault **   
Provisioned IOPS not available in the specified Availability Zone.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
The request would result in the user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

 ** TenantDatabaseQuotaExceeded **   
You attempted to create more tenant databases than are permitted in your AWS account.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_RestoreDBInstanceToPointInTime_Examples"></a>

### Example
<a name="API_RestoreDBInstanceToPointInTime_Example_1"></a>

This example illustrates one usage of RestoreDBInstanceToPointInTime.

#### Sample Request
<a name="API_RestoreDBInstanceToPointInTime_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=RestoreDBInstanceToPointInTime
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &SourceDBInstanceIdentifier=mysqldb
   &TargetDBInstanceIdentifier=mysqldb-pitr
   &UseLatestRestorableTime=true
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T233051Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=087a8eb41cb1ab0fc9ec1575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97
```

#### Sample Response
<a name="API_RestoreDBInstanceToPointInTime_Example_1_Response"></a>

```
<RestoreDBInstanceToPointInTimeResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RestoreDBInstanceToPointInTimeResult>
    <DBInstance>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DBInstanceStatus>creating</DBInstanceStatus>
      <MultiAZ>false</MultiAZ>
      <VpcSecurityGroups/>
      <DBInstanceIdentifier>mysqldb-pitr</DBInstanceIdentifier>
      <PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
      <PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
      <ReadReplicaDBInstanceIdentifiers/>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <LicenseModel>general-public-license</LicenseModel>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <EngineVersion>5.6.13</EngineVersion>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>pending-apply</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PubliclyAccessible>true</PubliclyAccessible>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <DBName>mysqldb</DBName>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
      <DBInstanceClass>db.m1.medium</DBInstanceClass>
    </DBInstance>
  </RestoreDBInstanceToPointInTimeResult>
  <ResponseMetadata>
    <RequestId>13447c70-be2c-11d3-f4c6-37db295f7674</RequestId>
  </ResponseMetadata>
</RestoreDBInstanceToPointInTimeResponse>
```

## See Also
<a name="API_RestoreDBInstanceToPointInTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RestoreDBInstanceToPointInTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RestoreDBInstanceToPointInTime) 

# RevokeDBSecurityGroupIngress
<a name="API_RevokeDBSecurityGroupIngress"></a>

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

**Note**  
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-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_RevokeDBSecurityGroupIngress_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBSecurityGroupName **   
The name of the DB security group to revoke ingress from.  
Type: String  
Required: Yes

 ** CIDRIP **   
The IP range to revoke access from. Must be a valid CIDR range. If `CIDRIP` is specified, `EC2SecurityGroupName`, `EC2SecurityGroupId` and `EC2SecurityGroupOwnerId` can't be provided.  
Type: String  
Required: No

 ** EC2SecurityGroupId **   
The id of the EC2 security group to revoke access from. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

 ** EC2SecurityGroupName **   
The name of the EC2 security group to revoke access from. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

 ** EC2SecurityGroupOwnerId **   
The AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.  
Type: String  
Required: No

## Response Elements
<a name="API_RevokeDBSecurityGroupIngress_ResponseElements"></a>

The following element is returned by the service.

 ** DBSecurityGroup **   
Contains the details for an Amazon RDS DB security group.  
This data type is used as a response element in the `DescribeDBSecurityGroups` action.  
Type: [DBSecurityGroup](API_DBSecurityGroup.md) object

## Errors
<a name="API_RevokeDBSecurityGroupIngress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` doesn't refer to an existing DB security group.  
HTTP Status Code: 404

 ** InvalidDBSecurityGroupState **   
The state of the DB security group doesn't allow deletion.  
HTTP Status Code: 400

## Examples
<a name="API_RevokeDBSecurityGroupIngress_Examples"></a>

### Example
<a name="API_RevokeDBSecurityGroupIngress_Example_1"></a>

This example illustrates one usage of RevokeDBSecurityGroupIngress.

#### Sample Request
<a name="API_RevokeDBSecurityGroupIngress_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
   ?Action=RevokeDBSecurityGroupIngress 
   &CIDRIP=192.0.0.1%2F32
   &DBSecurityGroupName=mydbsecuritygroup01
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
   &X-Amz-Date=20140428T233956Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=d9edabccacae36138704fb2b3cf6755ef08123862191b19d74582497b75e544a
```

#### Sample Response
<a name="API_RevokeDBSecurityGroupIngress_Example_1_Response"></a>

```
<RevokeDBSecurityGroupIngressResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <RevokeDBSecurityGroupIngressResult>
    <DBSecurityGroup>
      <EC2SecurityGroups/>
      <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>
      <IPRanges>
        <IPRange>
          <CIDRIP>192.0.0.1/32</CIDRIP>
          <Status>revoking</Status>
        </IPRange>
      </IPRanges>
      <OwnerId>803#########</OwnerId>
      <DBSecurityGroupName>mydbsecuritygroup01</DBSecurityGroupName>
    </DBSecurityGroup>
  </RevokeDBSecurityGroupIngressResult>
  <ResponseMetadata>
    <RequestId>579d8ba0-be2d-11d3-ae4f-eec568ed6b36</RequestId>
  </ResponseMetadata>
</RevokeDBSecurityGroupIngressResponse>
```

## See Also
<a name="API_RevokeDBSecurityGroupIngress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/RevokeDBSecurityGroupIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/RevokeDBSecurityGroupIngress) 

# StartActivityStream
<a name="API_StartActivityStream"></a>

Starts a database activity stream to monitor activity on the database. For more information, see [ Monitoring Amazon Aurora with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) in the *Amazon Aurora User Guide* or [ Monitoring Amazon RDS with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_StartActivityStream_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** KmsKeyId **   
The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
Type: String  
Required: Yes

 ** Mode **   
Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.  
Type: String  
Valid Values: `sync | async`   
Required: Yes

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the DB cluster, for example, `arn:aws:rds:us-east-1:12345667890:cluster:das-cluster`.  
Type: String  
Required: Yes

 ** ApplyImmediately **   
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.  
Type: Boolean  
Required: No

 ** EngineNativeAuditFieldsIncluded **   
Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_StartActivityStream_ResponseElements"></a>

The following elements are returned by the service.

 ** ApplyImmediately **   
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.  
Type: Boolean

 ** EngineNativeAuditFieldsIncluded **   
Indicates whether engine-native audit fields are included in the database activity stream.  
Type: Boolean

 ** KinesisStreamName **   
The name of the Amazon Kinesis data stream to be used for the database activity stream.  
Type: String

 ** KmsKeyId **   
The AWS KMS key identifier for encryption of messages in the database activity stream.  
Type: String

 ** Mode **   
The mode of the database activity stream.  
Type: String  
Valid Values: `sync | async` 

 ** Status **   
The status of the database activity stream.  
Type: String  
Valid Values: `stopped | starting | started | stopping` 

## Errors
<a name="API_StartActivityStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_StartActivityStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StartActivityStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StartActivityStream) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the `StopDBCluster` operation.

For more information, see [ Stopping and Starting an Aurora Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation only applies to Aurora DB clusters.

## Request Parameters
<a name="API_StartDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

## Response Elements
<a name="API_StartDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_StartDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBShardGroupState **   
The DB shard group must be in the available state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_StartDBCluster_Examples"></a>

### Example
<a name="API_StartDBCluster_Example_1"></a>

This example illustrates one usage of StartDBCluster.

#### Sample Request
<a name="API_StartDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=StartDBCluster
    &DBClusterIdentifier=mydbcluster
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request
    &X-Amz-Date=20131016T233051Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=087a8eb41cb1ab5f99e81575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97
```

## See Also
<a name="API_StartDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StartDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StartDBCluster) 

# StartDBInstance
<a name="API_StartDBInstance"></a>

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the `StopDBInstance` operation.

For more information, see [ Starting an Amazon RDS DB instance That Was Previously Stopped](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html) in the *Amazon RDS User Guide.* 

**Note**  
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use `StartDBCluster` instead.

## Request Parameters
<a name="API_StartDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied instance identifier.  
Type: String  
Required: Yes

## Response Elements
<a name="API_StartDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_StartDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.  
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.  
HTTP Status Code: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.  
HTTP Status Code: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` doesn't refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** InsufficientDBInstanceCapacity **   
The specified DB instance class isn't available in the specified Availability Zone.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** VpcEncryptionControlViolation **   
The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.  
HTTP Status Code: 400

## Examples
<a name="API_StartDBInstance_Examples"></a>

### Example
<a name="API_StartDBInstance_Example_1"></a>

This example illustrates one usage of StartDBInstance.

#### Sample Request
<a name="API_StartDBInstance_Example_1_Request"></a>

```
https://rds.amazonaws.com/
    ?Action=StartDBInstance
    &DBInstanceIdentifier=mydbinstance
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4EXAMPLE/20131016/us-west-1/rds/aws4_request
    &X-Amz-Date=20131016T233051Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
```

#### Sample Response
<a name="API_StartDBInstance_Example_1_Response"></a>

```
<StartDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <StartDBInstanceResult>
    <DBInstance>
      <AllocatedStorage>100</AllocatedStorage>
      <EnabledCloudwatchLogsExports>
        <member>alert</member>
        <member>audit</member>
        <member>listener</member>
        <member>trace</member>
      </EnabledCloudwatchLogsExports>
      <AssociatedRoles/>
      <DBParameterGroups>
        <DBParameterGroup>
          <DBParameterGroupName>default.oracle-ee-19</DBParameterGroupName>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        </DBParameterGroup>
      </DBParameterGroups>
      <AvailabilityZone>us-east-1b</AvailabilityZone>
      <DBSecurityGroups/>
      <Iops>1000</Iops>
      <PerformanceInsightsKMSKeyId>arn:aws:kms:us-east-1:123456789012:key/87c22544-4cac-4640-99de-cfdaa8760ad0</PerformanceInsightsKMSKeyId>
      <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:123456789012:log-group:RDSOSMetrics:log-stream:db-LENX3LYCR6OKTGWZZEXAMPLE</EnhancedMonitoringResourceArn>
      <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod>
      <EngineVersion>19.0.0.0.ru-2019-10.rur-2019-10.r1</EngineVersion>
      <MasterUsername>admin</MasterUsername>
      <InstanceCreateTime>2019-11-23T17:27:58.540Z</InstanceCreateTime>
      <DBInstanceClass>db.t3.medium</DBInstanceClass>
      <HttpEndpointEnabled>false</HttpEndpointEnabled>
      <ReadReplicaDBInstanceIdentifiers/>
      <CustomerOwnedIpEnabled>false</CustomerOwnedIpEnabled>
      <MonitoringInterval>60</MonitoringInterval>
      <DBInstanceStatus>starting</DBInstanceStatus>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:oracle-ee-19</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <CACertificateIdentifier>rds-ca-2019</CACertificateIdentifier>
      <DbInstancePort>0</DbInstancePort>
      <DbiResourceId>db-LENX3LYCR6OKTGWZEXAMPLE</DbiResourceId>
      <PreferredBackupWindow>08:31-09:01</PreferredBackupWindow>
      <DeletionProtection>false</DeletionProtection>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBInstanceArn>arn:aws:rds:us-east-1:123456789012:db:mydbinstance</DBInstanceArn>
      <Endpoint>
        <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
        <Address>mydbinstance.123example.us-east-1.rds.amazonaws.com</Address>
        <Port>1521</Port>
      </Endpoint>
      <Engine>oracle-ee</Engine>
      <MaxAllocatedStorage>1000</MaxAllocatedStorage>
      <PubliclyAccessible>true</PubliclyAccessible>
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
      <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled>
      <DBName>DBOR</DBName>
      <MultiAZ>false</MultiAZ>
      <DomainMemberships/>
      <CharacterSetName>AL32UTF8</CharacterSetName>
      <MonitoringRoleArn>arn:aws:iam::123456789012:role/rds-monitoring-role</MonitoringRoleArn>
      <StorageEncrypted>false</StorageEncrypted>
      <DBSubnetGroup>
        <VpcId>vpc-67a0bc1c</VpcId>
        <Subnets>
          <Subnet>
            <SubnetIdentifier>subnet-example1</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1a</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example12</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1e</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example3</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1f</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example4</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1d</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example5</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1b</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example6</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1c</Name>
            </SubnetAvailabilityZone>
          </Subnet>
        </Subnets>
        <SubnetGroupStatus>Complete</SubnetGroupStatus>
        <DBSubnetGroupDescription>Created from the RDS Management Console</DBSubnetGroupDescription>
        <DBSubnetGroupName>default-vpc-67a0bc1c</DBSubnetGroupName>
      </DBSubnetGroup>
      <TagList>
        <Tag>
          <Value>hr</Value>
          <Key>department</Key>
        </Tag>
        <Tag>
          <Value>rds</Value>
          <Key>type</Key>
        </Tag>
      </TagList>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-0417e54f</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <NcharCharacterSetName>AL16UTF16</NcharCharacterSetName>
      <LicenseModel>bring-your-own-license</LicenseModel>
      <PendingModifiedValues/>
      <PreferredMaintenanceWindow>sun:05:12-sun:05:42</PreferredMaintenanceWindow>
      <StorageType>io1</StorageType>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
    </DBInstance>
  </StartDBInstanceResult>
  <ResponseMetadata>
    <RequestId>9d4d8c94-7b81-4a64-8518-EXAMPLE</RequestId>
  </ResponseMetadata>
</StartDBInstanceResponse>
```

## See Also
<a name="API_StartDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StartDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StartDBInstance) 

# StartDBInstanceAutomatedBackupsReplication
<a name="API_StartDBInstanceAutomatedBackupsReplication"></a>

Enables replication of automated backups to a different AWS Region.

This command doesn't apply to RDS Custom.

For more information, see [ Replicating Automated Backups to Another AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_StartDBInstanceAutomatedBackupsReplication_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBInstanceArn **   
The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.  
Type: String  
Required: Yes

 ** BackupRetentionPeriod **   
The retention period for the replicated automated backups.  
Type: Integer  
Required: No

 ** KmsKeyId **   
The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.  
Type: String  
Required: No

 ** PreSignedUrl **   
In an AWS GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the `StartDBInstanceAutomatedBackupsReplication` operation to call in the AWS Region of the source DB instance. The presigned URL must be a valid request for the `StartDBInstanceAutomatedBackupsReplication` API operation that can run in the AWS Region that contains the source DB instance.  
This setting applies only to AWS GovCloud (US) Regions. It's ignored in other AWS Regions.  
To learn how to generate a Signature Version 4 signed request, see [ Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and [ Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).  
If you are using an AWS SDK tool or the AWS CLI, you can specify `SourceRegion` (or `--source-region` for the AWS CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source AWS Region.
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to associate with the replicated automated backups.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_StartDBInstanceAutomatedBackupsReplication_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstanceAutomatedBackup **   
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.  
Type: [DBInstanceAutomatedBackup](API_DBInstanceAutomatedBackup.md) object

## Errors
<a name="API_StartDBInstanceAutomatedBackupsReplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceAutomatedBackupQuotaExceeded **   
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.  
HTTP Status Code: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceAutomatedBackupState **   
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

 ** StorageTypeNotSupported **   
The specified `StorageType` can't be associated with the DB instance.  
HTTP Status Code: 400

## See Also
<a name="API_StartDBInstanceAutomatedBackupsReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication) 

# StartExportTask
<a name="API_StartExportTask"></a>

Starts 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.ExportSnapshotToS3.html).

For more information on exporting DB snapshot data, see [Exporting DB snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html) in the *Amazon RDS User Guide* or [Exporting DB cluster snapshot data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html) in the *Amazon Aurora User Guide*.

For more information on exporting DB cluster data, see [Exporting DB cluster data to Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_StartExportTask_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ExportTaskIdentifier **   
A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.  
Type: String  
Required: Yes

 ** IamRoleArn **   
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.  
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:  
+ s3:PutObject\$1
+ s3:GetObject\$1
+ s3:ListBucket
+ s3:DeleteObject\$1
+ s3:GetBucketLocation 
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:  
+  `arn:aws:s3:::your-s3-bucket ` 
+  `arn:aws:s3:::your-s3-bucket/*` 
Type: String  
Required: Yes

 ** KmsKeyId **   
The ID of the AWS KMS key to use to encrypt the data exported to Amazon S3. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the AWS KMS key policy:  
+ kms:CreateGrant
+ kms:DescribeKey
Type: String  
Required: Yes

 ** S3BucketName **   
The name of the Amazon S3 bucket to export the snapshot or cluster data to.  
Type: String  
Required: Yes

 ** SourceArn **   
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.  
Type: String  
Required: Yes

 **ExportOnly.member.N**   
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.  
Valid Values:  
+  `database` - Export all the data from a specified database.
+  `database.table` *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
+  `database.schema` *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
+  `database.schema.table` *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Type: Array of strings  
Required: No

 ** S3Prefix **   
The Amazon S3 bucket prefix to use as the file name and path of the exported data.  
Type: String  
Required: No

## Response Elements
<a name="API_StartExportTask_ResponseElements"></a>

The following elements are returned by the service.

 **ExportOnly.member.N**   
The data exported from the snapshot or cluster.  
Valid Values:  
+  `database` - Export all the data from a specified database.
+  `database.table` *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
+  `database.schema` *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
+  `database.schema.table` *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Type: Array of strings

 ** ExportTaskIdentifier **   
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.  
Type: String

 ** FailureCause **   
The reason the export failed, if it failed.  
Type: String

 ** IamRoleArn **   
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.  
Type: String

 ** KmsKeyId **   
The key identifier of the AWS KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.  
Type: String

 ** PercentProgress **   
The progress of the snapshot or cluster export task as a percentage.  
Type: Integer

 ** S3Bucket **   
The Amazon S3 bucket where the snapshot or cluster is exported to.  
Type: String

 ** S3Prefix **   
The Amazon S3 bucket prefix that is the file name and path of the exported data.  
Type: String

 ** SnapshotTime **   
The time when the snapshot was created.  
Type: Timestamp

 ** SourceArn **   
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.  
Type: String

 ** SourceType **   
The type of source for the export.  
Type: String  
Valid Values: `SNAPSHOT | CLUSTER` 

 ** Status **   
The progress status of the export task. The status can be one of the following:  
+  `CANCELED` 
+  `CANCELING` 
+  `COMPLETE` 
+  `FAILED` 
+  `IN_PROGRESS` 
+  `STARTING` 
Type: String

 ** TaskEndTime **   
The time when the snapshot or cluster export task ended.  
Type: Timestamp

 ** TaskStartTime **   
The time when the snapshot or cluster export task started.  
Type: Timestamp

 ** TotalExtractedDataInGB **   
The total amount of data exported, in gigabytes.  
Type: Integer

 ** WarningMessage **   
A warning about the snapshot or cluster export task.  
Type: String

## Errors
<a name="API_StartExportTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` doesn't refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` doesn't refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** ExportTaskAlreadyExists **   
You can't start an export task that's already running.  
HTTP Status Code: 400

 ** IamRoleMissingPermissions **   
The IAM role requires additional permissions to export to an Amazon S3 bucket.  
HTTP Status Code: 400

 ** IamRoleNotFound **   
The IAM role is missing for exporting to an Amazon S3 bucket.  
HTTP Status Code: 404

 ** InvalidExportOnly **   
The export is invalid for exporting to an Amazon S3 bucket.  
HTTP Status Code: 400

 ** InvalidExportSourceState **   
The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.  
HTTP Status Code: 400

 ** InvalidS3BucketFault **   
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the **SourceS3BucketName** and **S3IngestionRoleArn** values and try again.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
An error occurred accessing an AWS KMS key.  
HTTP Status Code: 400

## See Also
<a name="API_StartExportTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StartExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StartExportTask) 

# StopActivityStream
<a name="API_StopActivityStream"></a>

Stops a database activity stream that was started using the AWS console, the `start-activity-stream` AWS CLI command, or the `StartActivityStream` operation.

For more information, see [ Monitoring Amazon Aurora with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) in the *Amazon Aurora User Guide* or [ Monitoring Amazon RDS with Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) in the *Amazon RDS User Guide*.

## Request Parameters
<a name="API_StopActivityStream_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceArn **   
The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, `arn:aws:rds:us-east-1:12345667890:cluster:das-cluster`.  
Type: String  
Required: Yes

 ** ApplyImmediately **   
Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_StopActivityStream_ResponseElements"></a>

The following elements are returned by the service.

 ** KinesisStreamName **   
The name of the Amazon Kinesis data stream used for the database activity stream.  
Type: String

 ** KmsKeyId **   
The AWS KMS key identifier used for encrypting messages in the database activity stream.  
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.  
Type: String

 ** Status **   
The status of the database activity stream.  
Type: String  
Valid Values: `stopped | starting | started | stopping` 

## Errors
<a name="API_StopActivityStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The specified resource ID was not found.  
HTTP Status Code: 404

## See Also
<a name="API_StopActivityStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StopActivityStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StopActivityStream) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see [ Stopping and Starting an Aurora Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) in the *Amazon Aurora User Guide*.

**Note**  
This operation only applies to Aurora DB clusters.

## Request Parameters
<a name="API_StopDBCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBClusterIdentifier **   
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

## Response Elements
<a name="API_StopDBCluster_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.   
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `PromoteReadReplicaDBCluster`, `RestoreDBClusterFromS3`, `RestoreDBClusterFromSnapshot`, `RestoreDBClusterToPointInTime`, `StartDBCluster`, and `StopDBCluster`.  
For a Multi-AZ DB cluster, this data type is used as a response element in the operations `CreateDBCluster`, `DeleteDBCluster`, `DescribeDBClusters`, `FailoverDBCluster`, `ModifyDBCluster`, `RebootDBCluster`, `RestoreDBClusterFromSnapshot`, and `RestoreDBClusterToPointInTime`.  
For more information on Amazon Aurora DB clusters, see [ What is Amazon Aurora?](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the *Amazon Aurora User Guide.*   
For more information on Multi-AZ DB clusters, see [ Multi-AZ deployments with two readable standby DB instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide.*   
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_StopDBCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** InvalidDBShardGroupState **   
The DB shard group must be in the available state.  
HTTP Status Code: 400

## Examples
<a name="API_StopDBCluster_Examples"></a>

### Example
<a name="API_StopDBCluster_Example_1"></a>

This example illustrates one usage of StopDBCluster.

#### Sample Request
<a name="API_StopDBCluster_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
    ?Action=StopDBCluster
    &DBClusterIdentifier=mydbcluster
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request
    &X-Amz-Date=20131016T233051Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=087a8eb41cb1ab5f99e81575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97
```

## See Also
<a name="API_StopDBCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StopDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StopDBCluster) 

# StopDBInstance
<a name="API_StopDBInstance"></a>

Stops 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 instance restarts automatically after 7 days.

For more information, see [ Stopping an Amazon RDS DB Instance Temporarily](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html) in the *Amazon RDS User Guide.* 

**Note**  
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use `StopDBCluster` instead.

## Request Parameters
<a name="API_StopDBInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The user-supplied instance identifier.  
Type: String  
Required: Yes

 ** DBSnapshotIdentifier **   
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.  
Type: String  
Required: No

## Response Elements
<a name="API_StopDBInstance_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_StopDBInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` is already used by an existing snapshot.  
HTTP Status Code: 400

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

 ** SnapshotQuotaExceeded **   
The request would result in the user exceeding the allowed number of DB snapshots.  
HTTP Status Code: 400

## See Also
<a name="API_StopDBInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StopDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StopDBInstance) 

# StopDBInstanceAutomatedBackupsReplication
<a name="API_StopDBInstanceAutomatedBackupsReplication"></a>

Stops 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 AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide.* 

## Request Parameters
<a name="API_StopDBInstanceAutomatedBackupsReplication_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceDBInstanceArn **   
The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for example, `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.  
Type: String  
Required: Yes

## Response Elements
<a name="API_StopDBInstanceAutomatedBackupsReplication_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstanceAutomatedBackup **   
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.  
Type: [DBInstanceAutomatedBackup](API_DBInstanceAutomatedBackup.md) object

## Errors
<a name="API_StopDBInstanceAutomatedBackupsReplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## See Also
<a name="API_StopDBInstanceAutomatedBackupsReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication) 

# SwitchoverBlueGreenDeployment
<a name="API_SwitchoverBlueGreenDeployment"></a>

Switches 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 database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.

## Request Parameters
<a name="API_SwitchoverBlueGreenDeployment_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BlueGreenDeploymentIdentifier **   
The resource ID of the blue/green deployment.  
Constraints:  
+ Must match an existing blue/green deployment resource ID.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** SwitchoverTimeout **   
The amount of time, in seconds, for the switchover to complete.  
Default: 300  
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.  
Type: Integer  
Valid Range: Minimum value of 30.  
Required: No

## Response Elements
<a name="API_SwitchoverBlueGreenDeployment_ResponseElements"></a>

The following element is returned by the service.

 ** BlueGreenDeployment **   
Details about a blue/green deployment.  
For more information, see [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) in the *Amazon RDS User Guide* and [Using Amazon RDS Blue/Green Deployments for database updates](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) in the *Amazon Aurora User Guide*.  
Type: [BlueGreenDeployment](API_BlueGreenDeployment.md) object

## Errors
<a name="API_SwitchoverBlueGreenDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BlueGreenDeploymentNotFoundFault **   
 `BlueGreenDeploymentIdentifier` doesn't refer to an existing blue/green deployment.  
HTTP Status Code: 404

 ** InvalidBlueGreenDeploymentStateFault **   
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.  
HTTP Status Code: 400

## Examples
<a name="API_SwitchoverBlueGreenDeployment_Examples"></a>

### Example
<a name="API_SwitchoverBlueGreenDeployment_Example_1"></a>

This example illustrates one usage of SwitchoverBlueGreenDeployment.

#### Sample Request
<a name="API_SwitchoverBlueGreenDeployment_Example_1_Request"></a>

```
https://rds.us-west-2.amazonaws.com/
   ?Action=SwitchoverBlueGreenDeployment
   &BlueGreenDeploymentIdentifier=bgd-mdoyy2mn7vbkhhgg
   &SwitchoverTimeout=400
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-west-2/rds/aws4_request
   &X-Amz-Date=20230110T190520Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
```

#### Sample Response
<a name="API_SwitchoverBlueGreenDeployment_Example_1_Response"></a>

```
<SwitchoverBlueGreenDeploymentResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <SwitchoverBlueGreenDeploymentResult>
    <BlueGreenDeployment>
      <TagList/>
      <BlueGreenDeploymentName>my-blue-green-deployment</BlueGreenDeploymentName>
      <CreateTime>2023-01-10T18:42:09.330Z</CreateTime>
      <SwitchoverDetails>
        <member>
          <SourceMember>arn:aws:rds:us-west-2:123456789012:db:database-1</SourceMember>
          <TargetMember>arn:aws:rds:us-west-2:123456789012:db:database-1-green-7jtrw5</TargetMember>
          <Status>AVAILABLE</Status>
        </member>
      </SwitchoverDetails>
      <Source>arn:aws:rds:us-west-2:123456789012:db:database-1</Source>
      <BlueGreenDeploymentIdentifier>bgd-mdoyy2mn7vbkhhgg</BlueGreenDeploymentIdentifier>
      <Tasks>
        <member>
          <Name>CREATING_READ_REPLICA_OF_SOURCE</Name>
          <Status>COMPLETED</Status>
        </member>
        <member>
          <Name>CONFIGURE_BACKUPS</Name>
          <Status>COMPLETED</Status>
        </member>
      </Tasks>
      <Target>arn:aws:rds:us-west-2:123456789012:db:database-1-green-7jtrw5</Target>
      <Status>SWITCHOVER_IN_PROGRESS</Status>
    </BlueGreenDeployment>
  </SwitchoverBlueGreenDeploymentResult>
  <ResponseMetadata>
    <RequestId>c4f69d85-87e5-4fbb-b6b8-ccdb17404af6</RequestId>
  </ResponseMetadata>
</SwitchoverBlueGreenDeploymentResponse>
```

## See Also
<a name="API_SwitchoverBlueGreenDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/SwitchoverBlueGreenDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SwitchoverBlueGreenDeployment) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

Switches 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 primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see [Performing switchovers for Amazon Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover) in the *Amazon Aurora User Guide*.

**Note**  
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.

## Request Parameters
<a name="API_SwitchoverGlobalCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalClusterIdentifier **   
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.  
Constraints:  
+ Must match the identifier of an existing global database cluster (Aurora global database).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

 ** TargetDbClusterIdentifier **   
The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its AWS Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`   
Required: Yes

## Response Elements
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalCluster **   
A data type representing an Aurora global database.  
Type: [GlobalCluster](API_GlobalCluster.md) object

## Errors
<a name="API_SwitchoverGlobalCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` doesn't refer to an existing DB cluster.  
HTTP Status Code: 404

 ** GlobalClusterNotFoundFault **   
The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.  
HTTP Status Code: 404

 ** InvalidDBClusterStateFault **   
The requested operation can't be performed while the cluster is in this state.  
HTTP Status Code: 400

 ** InvalidGlobalClusterStateFault **   
The global cluster is in an invalid state and can't perform the requested operation.  
HTTP Status Code: 400

## See Also
<a name="API_SwitchoverGlobalCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SwitchoverGlobalCluster) 

# SwitchoverReadReplica
<a name="API_SwitchoverReadReplica"></a>

Switches 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.

## Request Parameters
<a name="API_SwitchoverReadReplica_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DBInstanceIdentifier **   
The DB instance identifier of the current standby database. This value is stored as a lowercase string.  
Constraints:  
+ Must match the identifier of an existing Oracle read replica DB instance.
Type: String  
Required: Yes

## Response Elements
<a name="API_SwitchoverReadReplica_ResponseElements"></a>

The following element is returned by the service.

 ** DBInstance **   
Contains the details of an Amazon RDS DB instance.  
This data type is used as a response element in the operations `CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.  
Type: [DBInstance](API_DBInstance.md) object

## Errors
<a name="API_SwitchoverReadReplica_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` doesn't refer to an existing DB instance.  
HTTP Status Code: 404

 ** InvalidDBInstanceState **   
The DB instance isn't in a valid state.  
HTTP Status Code: 400

## Examples
<a name="API_SwitchoverReadReplica_Examples"></a>

### Example
<a name="API_SwitchoverReadReplica_Example_1"></a>

The following example shows one use of SwitchoverReadReplica.

#### Sample Request
<a name="API_SwitchoverReadReplica_Example_1_Request"></a>

```
https://rds.us-east-1.amazonaws.com/
?Action=SwitchoverReadReplica
&DBInstanceIdentifier=new-primary
&Version=2014-10-31
&Signature=12345678caef670d84c14ffba62e107842557f934f1e68e5d38a2d219ae70527
```

#### Sample Response
<a name="API_SwitchoverReadReplica_Example_1_Response"></a>

```
<SwitchoverReadReplicaResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
    <SwitchoverReadReplicaResult>
        <DBInstance>
            <AllocatedStorage>20</AllocatedStorage>
            <ReadReplicaSourceDBInstanceIdentifier>bystanders-old-primary</ReadReplicaSourceDBInstanceIdentifier>
            <AssociatedRoles/>
            <DBParameterGroups>
                <DBParameterGroup>
                    <DBParameterGroupName>default.oracle-ee-19</DBParameterGroupName>
                    <ParameterApplyStatus>in-sync</ParameterApplyStatus>
                </DBParameterGroup>
            </DBParameterGroups>
            <AvailabilityZone>us-west-2c</AvailabilityZone>
            <DBSecurityGroups/>
            <StatusInfos>
                <DBInstanceStatusInfo>
                    <Normal>true</Normal>
                    <StatusType>read replication</StatusType>
                    <Status>replicating</Status>
                </DBInstanceStatusInfo>
            </StatusInfos>
            <EngineVersion>19.0.0.0.ru-2021-10.rur-2021-10.r1</EngineVersion>
            <MasterUsername>masteruser</MasterUsername>
            <InstanceCreateTime>2022-01-09T11:55:29.005Z</InstanceCreateTime>
            <DBInstanceClass>db.m4.xlarge</DBInstanceClass>
            <StorageThroughput>0</StorageThroughput>
            <HttpEndpointEnabled>false</HttpEndpointEnabled>
            <ReadReplicaDBInstanceIdentifiers/>
            <CustomerOwnedIpEnabled>false</CustomerOwnedIpEnabled>
            <MonitoringInterval>0</MonitoringInterval>
            <DBInstanceStatus>available</DBInstanceStatus>
            <BackupRetentionPeriod>1</BackupRetentionPeriod>
            <OptionGroupMemberships>
                <OptionGroupMembership>
                    <OptionGroupName>default:oracle-ee-19</OptionGroupName>
                    <Status>in-sync</Status>
                </OptionGroupMembership>
            </OptionGroupMemberships>
            <BackupTarget>region</BackupTarget>
            <CACertificateIdentifier>rds-ca-2019</CACertificateIdentifier>
            <DbInstancePort>0</DbInstancePort>
            <DbiResourceId>db-ABCDEFG12H3I4J5KLMNOPQR6ST</DbiResourceId>
            <PreferredBackupWindow>11:11-11:11</PreferredBackupWindow>
            <DeletionProtection>false</DeletionProtection>
            <DBInstanceIdentifier>new-primary</DBInstanceIdentifier>
            <DBInstanceArn>arn:aws:rds:us-west-2:123456789012:db:new-primary</DBInstanceArn>
            <Endpoint>
                <HostedZoneId>ABCD7F8REH8UF3</HostedZoneId>
                <Address>new-primary.abcdefgh0ijk.us-west-2.rds.amazonaws.com</Address>
                <Port>1521</Port>
            </Endpoint>
            <Engine>oracle-ee</Engine>
            <PubliclyAccessible>true</PubliclyAccessible>
            <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
            <NetworkType>IPV4</NetworkType>
            <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
            <ReplicaMode>open-read-only</ReplicaMode>
            <DBName>ORCL</DBName>
            <MultiAZ>false</MultiAZ>
            <DomainMemberships/>
            <CharacterSetName>AL32UTF8</CharacterSetName>
            <StorageEncrypted>false</StorageEncrypted>
            <DBSubnetGroup>
                <VpcId>vpc-2f206b57</VpcId>
                <Subnets>
                    <Subnet>
                        <SubnetIdentifier>subnet-ac26e0e6</SubnetIdentifier>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetOutpost/>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2a</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                    <Subnet>
                        <SubnetIdentifier>subnet-1a2bcde3</SubnetIdentifier>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetOutpost/>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2b</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                    <Subnet>
                        <SubnetIdentifier>subnet-a1b2c3de</SubnetIdentifier>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetOutpost/>
                        <SubnetAvailabilityZone><Name>us-west-2d</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                    <Subnet>
                        <SubnetIdentifier>subnet-a12345b6</SubnetIdentifier>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetOutpost/>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2c</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                </Subnets>
                <SubnetGroupStatus>Complete</SubnetGroupStatus>
                <DBSubnetGroupDescription>default</DBSubnetGroupDescription>
                <DBSubnetGroupName>default</DBSubnetGroupName>
            </DBSubnetGroup>
            <VpcSecurityGroups>
                <VpcSecurityGroupMembership>
                    <VpcSecurityGroupId>ab-12c3d45e</VpcSecurityGroupId>
                    <Status>active</Status>
                </VpcSecurityGroupMembership>
            </VpcSecurityGroups>
            <TagList/>
            <NcharCharacterSetName>AL16UTF16</NcharCharacterSetName>
            <LicenseModel>bring-your-own-license</LicenseModel>
            <PendingModifiedValues/>
            <PreferredMaintenanceWindow>tue:07:56-tue:08:26</PreferredMaintenanceWindow>
            <StorageType>gp2</StorageType>
            <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
            <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
        </DBInstance>
    </SwitchoverReadReplicaResult>
    <ResponseMetadata>
        <RequestId>abcd12ef-34g5-41d6-aed9-b6366d786923</RequestId>
    </ResponseMetadata>
</SwitchoverReadReplicaResponse>
```

## See Also
<a name="API_SwitchoverReadReplica_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rds-2014-10-31/SwitchoverReadReplica) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rds-2014-10-31/SwitchoverReadReplica)