# mulesoft Amazon RDS Connector - Full Documentation

<!-- document id=fef93b9fa688fed17f832988709de57569d3abfdac980532ee0d93c27ff38d78 url=/mulesoft/current/en-us/amazon-rds-connector/1.3/index.md -->

---
product: Amazon RDS Connector
version: 1.3
---

# Amazon RDS Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

Amazon RDS Connector v1.3

Anypoint Connector for Amazon RDS (Amazon RDS Connector) provides connectivity to the Amazon
Relational Database Service (Amazon RDS) API. Amazon RDS Connector enables you to interface with
Amazon RDS, which provides cost-efficient and resizable capacity and automation of time-consuming
administration tasks such as hardware provisioning, database setup, patching, and backups.

## Before You Begin

To use the Amazon RDS Connector, you must have the following:

- Access to Amazon Web Services - RDS

- AWS Identity and Access Management (IAM) user account credentials to access AWS with the connector

## Migration Information

The changes from Amazon RDS Connector **1.2.0** to **1.3.0** include the following:

- Added TLS configuration into the connector

- Upgraded `aws-java-sdk` to 1.11.649

- Upgraded `aws-connector-commons` to 2.2.0

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-amazon-rds-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

## Add the Connector to Your Project

Anypoint Studio provides two ways to add the connector to your Studio project:

- From the Exchange button in the Studio taskbar

- From the Mule Palette view

### Add the Connector Using Exchange

1.  In Studio, create a Mule project.

2.  Click the Exchange icon **(X)** in the upper-left of the Studio task bar.

3.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

4.  In Exchange, search for "rds".

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "rds" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

## Configure the Connector Global Element

To use Amazon RDS Connector in your Mule application, configure a global Amazon RDS element that all
the Amazon RDS connectors in your project can use.

1.  Click the **Global Elements** tab at the bottom of the canvas.

2.  On the Global Configuration Elements screen, click **Create**.  
    The following window displays:

    ![Global Configuration Elements Wizard](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-config-global-wizard.png)

3.  In the Choose Global Type wizard, expand **Connector Configuration**, select **Amazon RDS
    Configuration**, and click **Ok**.  
    The following window displays:

    ![Create DB Instance Configure](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-create-db-instance-config.png)

4.  Configure the parameters according to instructions below:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter a name for the configuration for the connector to reference.</p></div></div></td></tr><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>Enter the session token provided by AWS Security Token Service (STS).</p></div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>Enter an alphanumeric text string that uniquely identifies the user who owns the account.</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>Enter the key that is used as a password.</p></div></div></td></tr><tr><td><p><strong>Try Default AWS Credentials Provider Chain</strong></p></td><td><div><div><p>Select the checkbox to use temporary credentials.</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>Select the region to use for the Amazon RDS client. When you do not select a region, it defaults to 'us-east-1'.</p></div></div></td></tr></tbody></table>

    Placeholder values refer to a configuration file `mule-artifact.properties` placed in the
    `src/main/resources` folder of your project. You can either enter your credentials into the
    global configuration properties, or reference a configuration file that contains these values.
    For simpler maintenance and better reusability of your project, MuleSoft recommends that you use
    a configuration file. Keeping these values in a separate file is useful if you need to deploy to
    different environments, such as production, development, and QA, where your access credentials
    differ.

5.  On the Advanced tab, keep the Reconnection strategy default entries.

6.  Click **Test Connection** to confirm that the parameters of your global configuration are
    accurate, and that Mule is able to successfully connect to Amazon RDS.

7.  Click **OK** to save the global connector configurations.

### Configure With the XML Editor or Standalone

Ensure that you include the Amazon RDS namespaces in your configuration file.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

<!-- Put your flows and configuration elements here -->

</mule>
```

To configure Amazon RDS Connector in your application, create a global Amazon RDS configuration
outside and above your flows, using the following global configuration code:

```xml
<rds:config name="Amazon_RDS_Configuration">
	<rds:basic-connection
		accessKey="${config.accessKey}"
		secretKey="${config.secretKey}"
		region="${config.region}"/>
</rds:config>
```

If you or your Amazon Identity and Access Management users forget or lose the secret access key, you
can create a new access key.

## RDS Connector Operations

Amazon RDS connector supports the following operations:

### DB Instances

- CreateDBInstance

- CreateDBInstanceReadReplica

- DeleteDBInstance

- DescribeDBInstances

- ModifyDBInstance

- RebootDBInstance

- RestoreDBInstanceFromDBSnapshot

- RestoreDBInstanceToPointInTime

- StartDBInstance

- StopDBInstance

### DB Snapshots

- CreateDBSnapshot

- DeleteDBSnapshot

- DescribeDBSnapshots

- ModifyDBSnapshot

### Events

- DescribeEvents

### Reserved DB Instances

- DescribeReservedDBInstances

- DescribeReservedDBInstancesOfferings

- PurchaseReservedDBInstancesOffering

## Use the Connector

Amazon RDS connector is an operation-based connector, which means that when you add the connector to
your flow, you need to configure a specific web service operation for the connector to perform.

## Connector Namespace and Schema

When designing your application in Studio, the act of dragging the connector operation from the
palette onto the Anypoint Studio canvas should automatically populate the XML code with the
connector namespace and schema location.

Namespace: `http://www.mulesoft.org/schema/mule/rds`

Schema Location: `http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd`

If you are manually coding the Mule application in the Studio XML editor or other text editor, paste
the namespace and schema location into the header of your Configuration XML, inside the `<mule>`
tag.

```xml
<mule xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd">

      <!-- here it goes your global configuration elements and flows -->

</mule>
```

## Use Cases and Demos

- Create a DB instance of your choice over all the Amazon supported databases.

- Stop a DB instance that is available or in a running state.

- Start a DB instance that is in a stopped state.

- Retrieve information on one or all available DB instances.

- Create a DB snapshot for a DB instance.

- Retrieve information on one or all available DB snapshots.

- Delete a DB snapshot.

## Use the Connector in a Mule App in Studio

If you are developing a Mule application in Anypoint Studio 7.x, use this XML snippet in your
pom.xml file:

```xml
<dependency>
    <groupId>com.mulesoft.connectors</groupId>
    <artifactId>mule-amazon-rds-connector</artifactId>
    <version>x.x.x</version>
    <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

### Create a Database Instance

This demo Mule application creates a DB instance.

![Creating a DB instance](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-create-db-instance-use-case-flow.png)

1.  Create a new Mule Project in Anypoint Studio.

2.  Add the following properties to the `mule-artifact.properties` file for your Amazon RDS
    credentials and place it in the project’s `src/main/resources` directory.

    ```text
    config.accesskey=<Access Key>
    config.secretkey=<Secret Key>
    config.region=<Region>
    ```

3.  Drag an HTTP Listener operation onto the canvas and configure the following parameters:

    ![RDS HTTP config props](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-http-props.png)

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Listener</p></div></div></td></tr><tr><td><p><strong>Extension Configuration</strong></p></td><td><div><div><p>If no HTTP element has been created yet, click the plus sign to add a new HTTP Listener Configuration and click OK (leave the values to its defaults).</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p><code>/create-db-instance</code></p></div></div></td></tr></tbody></table>

4.  Drag a Transform Message component after the HTTP connector to retrieve the HTTP query
    parameters and set the payload.

5.  Click the component to open its properties editor.  
    The DataWeave script should look similar to the following:

    ```dataweave
    %dw 2.0
    output application/java
    ---
    {
    	dbInstanceClass : attributes.queryParams.dbInstanceClass,
    	dbInstanceIdentifier : attributes.queryParams.dbInstanceIdentifier,
    	engine : attributes.queryParams.engine,
    	allocatedStorage : attributes.queryParams.allocatedStorage,
    	masterUsername : attributes.queryParams.masterUsername,
    	masterUserPassword : attributes.queryParams.masterUserPassword
    }
    ```

6.  Add a Logger component after the Transform Message component to print the payload data that was
    set in the previous processor to the Mule Console.

7.  Configure the Logger according to the table below:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Logger (or any other name you prefer)</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p><code>#[payload]</code></p></div></div></td></tr><tr><td><p><strong>Level</strong></p></td><td><div><div><p>INFO</p></div></div></td></tr></tbody></table>

8.  Drag the Amazon RDS Connector next to the Logger component.

9.  Configure the RDS connector by adding a new Amazon RDS Global Element:

    1.  Click the plus sign next to the Extension Configuration field.

    2.  Configure the global element according to the table below:

        <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Value</strong></p></td><td><div><div><p>Name</p></div></div></td></tr><tr><td><p><strong>Enter a name for the configuration for the connector to reference.</strong></p></td><td><div><div><p>&lt;Configuration_Name&gt;</p></div></div></td></tr><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>Session token provided by AWS Security Token Service (STS)</p></div></div></td></tr><tr><td><p><strong><code>${config.sessiontoken}</code></strong></p></td><td><div><div><p>Access Key</p></div></div></td></tr><tr><td><p><strong>Alphanumeric text string that uniquely identifies the user who owns the account</strong></p></td><td><div><div><p><code>${config.accesskey}</code></p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>Key that plays the role of a password</p></div></div></td></tr><tr><td><p><strong><code>${config.secretkey}</code></strong></p></td><td><div><div><p>Region Endpoint</p></div></div></td></tr><tr><td><p><strong>Region to set for the Amazon RDS Client</strong></p></td><td><div><div><p>When not selected from the drop down list, it defaults to 'us-east-1'.</p></div></div></td></tr></tbody></table>

    3.  Your configuration should look like this:

        ![RDS use case config](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-create-db-instance-config.png)

    4.  The corresponding XML configuration should be as follows:

        ```xml
        <rds:config name="Amazon_RDS_Configuration">
            <rds:basic-connection accessKey="${config.accessKey}" secretKey="${config.secretKey}"/>
        </rds:config>
        ```

10. Click **Test Connection** to confirm that Mule can connect with the Amazon RDS instance.

11. If the connection is successful, click **OK** to save the configurations. Otherwise, review or
    correct any incorrect parameters, then test again.

12. Back in the properties editor of the Amazon RDS connector, configure the parameters for the
    createDbInstance operation:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td colspan="2"><p><strong>General</strong></p></td></tr><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Enter a the name to display for the Create DB instance.</p></div></div></td></tr><tr><td><p><strong>Extension Configuration</strong></p></td><td><div><div><p>Enter the reference name to the global element you created.</p></div></div></td></tr><tr><td><p><strong>Db instance class</strong></p></td><td><div><div><p><code>#[payload.dbInstanceClass]</code></p></div></div></td></tr><tr><td><p><strong>Db instance identifier</strong></p></td><td><div><div><p>Enter a valid identifier to uniquely identify the DB instance.</p></div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>Choose from among the six DB engines that Amazon RDS supports.</p></div></div></td></tr><tr><td colspan="2"><p><strong>Security</strong></p></td></tr><tr><td><p><strong>Master username</strong></p></td><td><div><div><p>Enter a valid user name for the database.</p></div></div></td></tr><tr><td><p><strong>Master user password</strong></p></td><td><div><div><p>Enter the password for the database user.</p></div></div></td></tr><tr><td colspan="2"><p><strong>Storage and Maintenance</strong></p></td></tr><tr><td><p><strong>Allocated storage</strong></p></td><td><div><div><p>A number representing the storage in GB.</p></div></div></td></tr></tbody></table>

    ![Create DB instance parameter props](/mulesoft/current/en-us/amazon-rds-connector/1.3/_images/amazon-rds-create-db-instance-param-config.png)

13. Verify that your XML looks like this:

    ```xml
    <rds:create-db-instance
    	config-ref="Amazon_RDS_Configuration"
    	dbInstanceClass="#[payload.dbInstanceClass]"
    	dbInstanceIdentifier="#[payload.dbInstanceIdentifier]"
    	engine="#[payload.engine]"
    	allocatedStorage="#[payload.allocatedStorage]"
    	doc:name="Create db instance"
    	masterUsername="#[payload.masterUsername]"
    	masterUserPassword="#[payload.masterUserPassword]"/>
    ```

14. Add a Logger component after the RDS connector to print the payload data that was output from
    the Create DB instance processor to the Mule Console. Configure the Logger according to the
    table below.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Logger (or any other name you prefer)</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p><code>#[payload]</code></p></div></div></td></tr><tr><td><p><strong>Level</strong></p></td><td><div><div><p>INFO</p></div></div></td></tr></tbody></table>

15. Drag a Transform Message component after the Logger component to set the payload that would be
    transferred to the browser.

16. Click the component to open its properties editor. The DataWeave script should look similar to
    the following:

    ```dataweave
    %dw 2.0
    output application/json
    ---
    {
        success: true,
        info: payload
    }
    ```

17. Save and Run the project as a Mule Application:  
    In Package Explorer, right-click the project and click **Run As > Mule Application**.

18. Open a browser and check the response after entering the URL
    `http://localhost:8081/create-db-instance`.  
    You should see the generated DB instance ID in the browser and its information in the console.

### Demo XML Code

Paste this code into your XML Editor to load the flow for this example use case into your Mule
application.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<http:listener-config
		name="HTTP_Listener_config"
		doc:name="HTTP Listener config">
		<http:listener-connection
			host="127.0.0.1"
			port="8081" />
	</http:listener-config>

	<rds:config
		name="Amazon_RDS_Configuration"
		doc:name="Amazon RDS Configuration">
		<rds:basic-connection
			accessKey="${config.accessKey}"
			secretKey="${config.secretKey}" />
	</rds:config>

	<flow name="create-db-instance-flow">
		<http:listener
			config-ref="HTTP_Listener_config"
			path="/create-db-instance"
			doc:name="Listener"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
{
	dbInstanceClass : attributes.queryParams.dbInstanceClass,
	dbInstanceIdentifier : attributes.queryParams.dbInstanceIdentifier,
	engine : attributes.queryParams.engine,
	allocatedStorage : attributes.queryParams.allocatedStorage,
	masterUsername : attributes.queryParams.masterUsername,
	masterUserPassword : attributes.queryParams.masterUserPassword
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>

		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
		<rds:create-db-instance
			config-ref="Amazon_RDS_Configuration"
			dbInstanceClass="#[payload.dbInstanceClass]"
			dbInstanceIdentifier="#[payload.dbInstanceIdentifier]"
			engine="#[payload.engine]"
			allocatedStorage="#[payload.allocatedStorage]"
			doc:name="Create db instance"
		 	masterUsername="#[payload.masterUsername]"
			masterUserPassword="#[payload.masterUserPassword]"/>

		 <logger level="INFO" doc:name="Logger" message="#[payload]"/>

		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	success: true,
    info: payload
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>

	</flow>

</mule>
```

## See Also

- [Amazon RDS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-rds-connector-release-notes-mule-4)

- [Amazon RDS Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-amazon-rds-connector/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=97bb4f4e84a8024bff8f8c0bad0cdee87942022fdbbd2f2e7fe411852655e016 url=/mulesoft/current/en-us/amazon-rds-connector/latest/index.md -->

---
product: Amazon RDS Connector
version: 1.4
is-latest-version: true
---

# Amazon RDS Connector 1.4

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

Anypoint Connector for Amazon RDS (Amazon RDS Connector) provides connectivity to the Amazon
Relational Database Service (Amazon RDS) API. Amazon RDS Connector enables you to interface with
Amazon RDS, which provides cost-efficient and resizable capacity and automation of time-consuming
administration tasks such as hardware provisioning, database setup, patching, and backups.

## Before You Begin

To use the Amazon RDS Connector, you must have the following:

- Access to Amazon Web Services - RDS

- AWS Identity and Access Management (IAM) user account credentials to access AWS with the connector

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-amazon-rds-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

## Add the Connector to Your Project

Anypoint Studio provides two ways to add the connector to your Studio project:

- From the Exchange button in the Studio taskbar

- From the Mule Palette view

### Add the Connector Using Exchange

1.  In Studio, create a Mule project.

2.  Click the Exchange icon **(X)** in the upper-left of the Studio task bar.

3.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

4.  In Exchange, search for "rds".

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "rds" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

## Configure the Connector Global Element

To use Amazon RDS Connector in your Mule application, configure a global Amazon RDS element that all
the Amazon RDS connectors in your project can use.

1.  Click the **Global Elements** tab at the bottom of the canvas.

2.  On the Global Configuration Elements screen, click **Create**.  
    The following window displays:

    ![Global Configuration Elements Wizard](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-config-global-wizard.png)

3.  In the Choose Global Type wizard, expand **Connector Configuration**, select **Amazon RDS
    Configuration**, and click **Ok**.  
    The following window displays:

    ![Create DB Instance Configure](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-create-db-instance-config.png)

4.  Configure the parameters according to instructions below:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter a name for the configuration for the connector to reference.</p></div></div></td></tr><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>Enter the session token provided by AWS Security Token Service (STS).</p></div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>Enter an alphanumeric text string that uniquely identifies the user who owns the account.</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>Enter the key that is used as a password.</p></div></div></td></tr><tr><td><p><strong>Try Default AWS Credentials Provider Chain</strong></p></td><td><div><div><p>Select the checkbox to use temporary credentials.</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>Select the region to use for the Amazon RDS client. When you do not select a region, it defaults to 'us-east-1'.</p></div></div></td></tr></tbody></table>

    Placeholder values refer to a configuration file `mule-artifact.properties` placed in the
    `src/main/resources` folder of your project. You can either enter your credentials into the
    global configuration properties, or reference a configuration file that contains these values.
    For simpler maintenance and better reusability of your project, MuleSoft recommends that you use
    a configuration file. Keeping these values in a separate file is useful if you need to deploy to
    different environments, such as production, development, and QA, where your access credentials
    differ.

5.  On the Advanced tab, keep the Reconnection strategy default entries.

6.  Click **Test Connection** to confirm that the parameters of your global configuration are
    accurate, and that Mule is able to successfully connect to Amazon RDS.

7.  Click **OK** to save the global connector configurations.

### Configure With the XML Editor or Standalone

Ensure that you include the Amazon RDS namespaces in your configuration file.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

<!-- Put your flows and configuration elements here -->

</mule>
```

To configure Amazon RDS Connector in your application, create a global Amazon RDS configuration
outside and above your flows, using the following global configuration code:

```xml
<rds:config name="Amazon_RDS_Configuration">
	<rds:basic-connection
		accessKey="${config.accessKey}"
		secretKey="${config.secretKey}"
		region="${config.region}"/>
</rds:config>
```

If you or your Amazon Identity and Access Management users forget or lose the secret access key, you
can create a new access key.

## Use the Connector

Amazon RDS connector is an operation-based connector, which means that when you add the connector to
your flow, you need to configure a specific web service operation for the connector to perform.

## Connector Namespace and Schema

When designing your application in Studio, the act of dragging the connector operation from the
palette onto the Anypoint Studio canvas should automatically populate the XML code with the
connector namespace and schema location.

Namespace: `http://www.mulesoft.org/schema/mule/rds`

Schema Location: `http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd`

If you are manually coding the Mule application in the Studio XML editor or other text editor, paste
the namespace and schema location into the header of your Configuration XML, inside the `<mule>`
tag.

```xml
<mule xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd">

      <!-- here it goes your global configuration elements and flows -->

</mule>
```

## Use Cases and Demos

- Create a DB instance of your choice over all the Amazon supported databases.

- Stop a DB instance that is available or in a running state.

- Start a DB instance that is in a stopped state.

- Retrieve information on one or all available DB instances.

- Create a DB snapshot for a DB instance.

- Retrieve information on one or all available DB snapshots.

- Delete a DB snapshot.

## Use the Connector in a Mule App in Studio

If you are developing a Mule application in Anypoint Studio 7.x, use this XML snippet in your
pom.xml file:

```xml
<dependency>
    <groupId>com.mulesoft.connectors</groupId>
    <artifactId>mule-amazon-rds-connector</artifactId>
    <version>x.x.x</version>
    <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

### Create a Database Instance

This demo Mule application creates a DB instance.

![Creating a DB instance](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-create-db-instance-use-case-flow.png)

1.  Create a new Mule Project in Anypoint Studio.

2.  Add the following properties to the `mule-artifact.properties` file for your Amazon RDS
    credentials and place it in the project’s `src/main/resources` directory.

    ```text
    config.accesskey=<Access Key>
    config.secretkey=<Secret Key>
    config.region=<Region>
    ```

3.  Drag an HTTP Listener operation onto the canvas and configure the following parameters:

    ![RDS HTTP config props](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-http-props.png)

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Listener</p></div></div></td></tr><tr><td><p><strong>Extension Configuration</strong></p></td><td><div><div><p>If no HTTP element has been created yet, click the plus sign to add a new HTTP Listener Configuration and click OK (leave the values to its defaults).</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p><code>/create-db-instance</code></p></div></div></td></tr></tbody></table>

4.  Drag a Transform Message component after the HTTP connector to retrieve the HTTP query
    parameters and set the payload.

5.  Click the component to open its properties editor.  
    The DataWeave script should look similar to the following:

    ```dataweave
    %dw 2.0
    output application/java
    ---
    {
    	dbInstanceClass : attributes.queryParams.dbInstanceClass,
    	dbInstanceIdentifier : attributes.queryParams.dbInstanceIdentifier,
    	engine : attributes.queryParams.engine,
    	allocatedStorage : attributes.queryParams.allocatedStorage,
    	masterUsername : attributes.queryParams.masterUsername,
    	masterUserPassword : attributes.queryParams.masterUserPassword
    }
    ```

6.  Add a Logger component after the Transform Message component to print the payload data that was
    set in the previous processor to the Mule Console.

7.  Configure the Logger according to the table below:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Logger (or any other name you prefer)</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p><code>#[payload]</code></p></div></div></td></tr><tr><td><p><strong>Level</strong></p></td><td><div><div><p>INFO</p></div></div></td></tr></tbody></table>

8.  Drag the Amazon RDS Connector next to the Logger component.

9.  Configure the RDS connector by adding a new Amazon RDS Global Element:

    1.  Click the plus sign next to the Extension Configuration field.

    2.  Configure the global element according to the table below:

        <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Value</strong></p></td><td><div><div><p>Name</p></div></div></td></tr><tr><td><p><strong>Enter a name for the configuration for the connector to reference.</strong></p></td><td><div><div><p>&lt;Configuration_Name&gt;</p></div></div></td></tr><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>Session token provided by AWS Security Token Service (STS)</p></div></div></td></tr><tr><td><p><strong><code>${config.sessiontoken}</code></strong></p></td><td><div><div><p>Access Key</p></div></div></td></tr><tr><td><p><strong>Alphanumeric text string that uniquely identifies the user who owns the account</strong></p></td><td><div><div><p><code>${config.accesskey}</code></p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>Key that plays the role of a password</p></div></div></td></tr><tr><td><p><strong><code>${config.secretkey}</code></strong></p></td><td><div><div><p>Region Endpoint</p></div></div></td></tr><tr><td><p><strong>Region to set for the Amazon RDS Client</strong></p></td><td><div><div><p>When not selected from the drop down list, it defaults to 'us-east-1'.</p></div></div></td></tr></tbody></table>

    3.  Your configuration should look like this:

        ![RDS use case config](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-create-db-instance-config.png)

    4.  The corresponding XML configuration should be as follows:

        ```xml
        <rds:config name="Amazon_RDS_Configuration">
            <rds:basic-connection accessKey="${config.accessKey}" secretKey="${config.secretKey}"/>
        </rds:config>
        ```

10. Click **Test Connection** to confirm that Mule can connect with the Amazon RDS instance.

11. If the connection is successful, click **OK** to save the configurations. Otherwise, review or
    correct any incorrect parameters, then test again.

12. Back in the properties editor of the Amazon RDS connector, configure the parameters for the
    createDbInstance operation:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td colspan="2"><p><strong>General</strong></p></td></tr><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Enter a the name to display for the Create DB instance.</p></div></div></td></tr><tr><td><p><strong>Extension Configuration</strong></p></td><td><div><div><p>Enter the reference name to the global element you created.</p></div></div></td></tr><tr><td><p><strong>Db instance class</strong></p></td><td><div><div><p><code>#[payload.dbInstanceClass]</code></p></div></div></td></tr><tr><td><p><strong>Db instance identifier</strong></p></td><td><div><div><p>Enter a valid identifier to uniquely identify the DB instance.</p></div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>Choose from among the six DB engines that Amazon RDS supports.</p></div></div></td></tr><tr><td colspan="2"><p><strong>Security</strong></p></td></tr><tr><td><p><strong>Master username</strong></p></td><td><div><div><p>Enter a valid user name for the database.</p></div></div></td></tr><tr><td><p><strong>Master user password</strong></p></td><td><div><div><p>Enter the password for the database user.</p></div></div></td></tr><tr><td colspan="2"><p><strong>Storage and Maintenance</strong></p></td></tr><tr><td><p><strong>Allocated storage</strong></p></td><td><div><div><p>A number representing the storage in GB.</p></div></div></td></tr></tbody></table>

    ![Create DB instance parameter props](/mulesoft/current/en-us/amazon-rds-connector/latest/_images/amazon-rds-create-db-instance-param-config.png)

13. Verify that your XML looks like this:

    ```xml
    <rds:create-db-instance
    	config-ref="Amazon_RDS_Configuration"
    	dbInstanceClass="#[payload.dbInstanceClass]"
    	dbInstanceIdentifier="#[payload.dbInstanceIdentifier]"
    	engine="#[payload.engine]"
    	allocatedStorage="#[payload.allocatedStorage]"
    	doc:name="Create db instance"
    	masterUsername="#[payload.masterUsername]"
    	masterUserPassword="#[payload.masterUserPassword]"/>
    ```

14. Add a Logger component after the RDS connector to print the payload data that was output from
    the Create DB instance processor to the Mule Console. Configure the Logger according to the
    table below.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>Logger (or any other name you prefer)</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p><code>#[payload]</code></p></div></div></td></tr><tr><td><p><strong>Level</strong></p></td><td><div><div><p>INFO</p></div></div></td></tr></tbody></table>

15. Drag a Transform Message component after the Logger component to set the payload that would be
    transferred to the browser.

16. Click the component to open its properties editor. The DataWeave script should look similar to
    the following:

    ```dataweave
    %dw 2.0
    output application/json
    ---
    {
        success: true,
        info: payload
    }
    ```

17. Save and Run the project as a Mule Application:  
    In Package Explorer, right-click the project and click **Run As > Mule Application**.

18. Open a browser and check the response after entering the URL
    `http://localhost:8081/create-db-instance`.  
    You should see the generated DB instance ID in the browser and its information in the console.

### Demo XML Code

Paste this code into your XML Editor to load the flow for this example use case into your Mule
application.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:rds="http://www.mulesoft.org/schema/mule/rds"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-current.xsd
	http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/rds
	http://www.mulesoft.org/schema/mule/rds/current/mule-rds.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<http:listener-config
		name="HTTP_Listener_config"
		doc:name="HTTP Listener config">
		<http:listener-connection
			host="127.0.0.1"
			port="8081" />
	</http:listener-config>

	<rds:config
		name="Amazon_RDS_Configuration"
		doc:name="Amazon RDS Configuration">
		<rds:basic-connection
			accessKey="${config.accessKey}"
			secretKey="${config.secretKey}" />
	</rds:config>

	<flow name="create-db-instance-flow">
		<http:listener
			config-ref="HTTP_Listener_config"
			path="/create-db-instance"
			doc:name="Listener"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
{
	dbInstanceClass : attributes.queryParams.dbInstanceClass,
	dbInstanceIdentifier : attributes.queryParams.dbInstanceIdentifier,
	engine : attributes.queryParams.engine,
	allocatedStorage : attributes.queryParams.allocatedStorage,
	masterUsername : attributes.queryParams.masterUsername,
	masterUserPassword : attributes.queryParams.masterUserPassword
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>

		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
		<rds:create-db-instance
			config-ref="Amazon_RDS_Configuration"
			dbInstanceClass="#[payload.dbInstanceClass]"
			dbInstanceIdentifier="#[payload.dbInstanceIdentifier]"
			engine="#[payload.engine]"
			allocatedStorage="#[payload.allocatedStorage]"
			doc:name="Create db instance"
		 	masterUsername="#[payload.masterUsername]"
			masterUserPassword="#[payload.masterUserPassword]"/>

		 <logger level="INFO" doc:name="Logger" message="#[payload]"/>

		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	success: true,
    info: payload
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>

	</flow>

</mule>
```

## See Also

- [Amazon RDS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-rds-connector-release-notes-mule-4)

- [Amazon RDS Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-amazon-rds-connector/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8f6d942dfd10b671ee47b6d05a34aa666030c32093e16b01b329812d053b256c url=/mulesoft/current/en-us/amazon-rds-connector/latest/amazon-rds-connector-reference.md -->

---
product: Amazon RDS Connector
version: 1.4
is-latest-version: true
---

# Amazon RDS Connector 1.4 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

Anypoint Connector for Amazon RDS (Amazon RDS Connector) provides connectivity to the Amazon
Relational Database Service (Amazon RDS) API, enabling you to interface with Amazon RDS to provide
cost-efficient and resizable capacity while automating time-consuming administration tasks such as
hardware provisioning, database setup, patching and backups.

Release Notes:
[Amazon RDS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-rds-connector-release-notes-mule-4)

## Configurations

---

### Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#config_basic">Basic</a></p></li><li><p><a href="#config_role">Role</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Connection Types

### Basic

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The session token provided by Amazon STS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit used in the connection timeout configurations.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit used in the socket timeout configurations.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Set the topic region endpoint.</p></div></div></td><td><div><div><p>US_EAST_1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to true to obtain credentials from the AWS environment, See <a href="https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html">Using credentials providers in the AWS SDK for Java 2.x</a>.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom Service Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Role

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Role ARN unique identifies role to assume to gain cross account access.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>External ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A unique identifier used when assuming an IAM role in an external account. Provide the value specified by the administrator of the target account for added security.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom STS Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit used in the connection timeout configurations.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit used in the socket timeout configurations.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Set the topic region endpoint.</p></div></div></td><td><div><div><p>US_EAST_1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to true to obtain credentials from the AWS environment, See <a href="https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html">Using credentials providers in the AWS SDK for Java 2.x</a>.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom Service Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Operations

- [Copy Db Snapshot](#copyDbSnapshot)

- [Create DB Instance](#createDbInstance)

- [Create DB Instance Read Replica](#createDbInstanceReadReplica)

- [Create DB Snapshot](#createDbSnapshot)

- [Delete DB Instance](#deleteDbInstance)

- [Delete DB Snapshot](#deleteDbSnapshot)

- [Describe DB Instances](#describeDbInstances)

- [Describe DB Snapshots](#describeDbSnapshots)

- [Describe Events](#describeEvents)

- [Describe Reserved DB Instances](#describeReservedDbInstances)

- [Describe Reserved DB Instances Offerings](#describeReservedDbInstancesOfferings)

- [Modify DB Instance](#modifyDbInstance)

- [Modify DB Snapshot](#modifyDbSnapshot)

- [Purchase Reserved DB Instances Offering](#purchaseReservedDbInstancesOffering)

- [Reboot DB Instance](#rebootDbInstance)

- [Restore DB Instance From DB Snapshot](#restoreDbInstanceFromDbSnapshot)

- [Restore DB Instance To Point In Time](#restoreDbInstanceToPointInTime)

- [Start DB Instance](#startDbInstance)

- [Stop DB Instance](#stopDbInstance)

### Copy Db Snapshot

`<rds:copy-db-snapshot>`

This operation copies a DBSnapshot. The source DBSnapshot must be in the "available" state.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CopyDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the source DB snapshot.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the copy of the snapshot.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Create DB Instance

`<rds:create-db-instance>`

This operation creates a new database instance.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Cluster Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Security Groups</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>VPC Security Group IDs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>KMS Key ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Port Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Character Set Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Create DB Instance Read Replica

`<rds:create-db-instance-read-replica>`

This operation creates a new DB instance that acts as a Read Replica for an existing source DB
instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.

Amazon Aurora does not support this action. You must call the `CreateDBInstance` action to create a
DB instance for an Aurora DB cluster.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies the accessibility options for the DB instance.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a DB subnet group for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>KMS Key ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The AWS KMS key ID for an encrypted Read Replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pre-Signed URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL that contains a Signature Version 4 signed request for the create-db-instance-read-replica API action in the source AWS Region that contains the source DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this parameter to <code>true</code> to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier of the Read Replica.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the DB instance that will act as the source for the Read Replica.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Read Replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Amazon EC2 Availability Zone that the Read Replica will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number that the DB instance uses for connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The option group the DB instance will be associated with.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Region</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the region that contains the source for the read replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Create DB Snapshot

`<rds:create-db-snapshot>`

This operation creates a DBSnapshot. The source DBInstance must be in the "available" state.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier. The unique key that identifies a DB instance.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the DB snapshot.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Delete DB Instance

`<rds:delete-db-instance>`

The Delete DB Instance action deletes a previously provisioned DB instance. For more information,
see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier for the DB instance to be deleted. This parameter isn’t case-sensitive.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Final DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Final Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether a final DB snapshot is created before the DB instance is deleted.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Delete DB Snapshot

`<rds:delete-db-snapshot>`

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DBSnapshot identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Describe DB Instances

`<rds:describe-db-instances>`

Returns information about provisioned RDS instances. This API supports pagination. For more
information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Filters</strong></p></td><td><div><div><p>Array of <a href="#Filter">Filter</a></p></div></div></td><td><div><div><p>A filter that specifies one or more DB instances to describe.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation’s output will be placed.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Array of Message of <a href="#DBInstance">DB Instance</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Describe DB Snapshots

`<rds:describe-db-snapshots>`

Returns information about DB snapshots. This API action supports pagination. For more information,
see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshots.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the DB instance to retrieve the list of DB snapshots for.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Public</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Shared</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of snapshots to be returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Records</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of records to include in the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Filters</strong></p></td><td><div><div><p>Array of <a href="#Filter">Filter</a></p></div></div></td><td><div><div><p>This parameter is not currently supported.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of <a href="#DBSnapshot">DB Snapshot</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Describe Events

`<rds:describe-events>`

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups
for the past 14 days. Events specific to a particular DB instance, DB security group, database
snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default,
the past hour of events are returned. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of minutes to retrieve events for.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>End Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Event Categories</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>A list of event categories that trigger notifications for a event notification subscription.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The event source to retrieve events for. If no value is specified, all events are returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Start Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of <a href="#Event">Event</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Describe Reserved DB Instances

`<rds:describe-reserved-db-instances>`

Returns information about reserved DB instances for this account, or about a specified reserved DB
instance. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstances.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reserved DB Instance ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The reserved DB instance identifier filter value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The product description filter value. Specify this parameter to show only those reservations matching the specified product description.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of [<a href="#ReservedDBInstance">Reserved DB Instance</a>] payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

### Describe Reserved DB Instances Offerings

`<rds:describe-reserved-db-instances-offerings>`

Lists available reserved DB instance offerings. For more information, see this operation in the
Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstancesOfferings.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of [<a href="#ReservedDBInstancesOffering">Reserved DB Instances Offering</a>] payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Modify DB Instance

`<rds:modify-db-instance>`

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. For more information, see this
operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Major Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Apply Immediately</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Security Groups</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>VPC Security Group IDs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>CA Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Port Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>New DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Modify DB Snapshot

`<rds:modify-db-snapshot>`

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
You can update the engine version to either a new major or minor engine version.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the DB snapshot to modify.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The engine version to update the DB snapshot to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Purchase Reserved DB Instances Offering

`<rds:purchase-reserved-db-instances-offering>`

Purchases a reserved DB instance offering. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PurchaseReservedDBInstancesOffering.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the Reserved DB instance offering to purchase.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of instances to reserve.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Customer-specified identifier to track this reservation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#ReservedDBInstance">Reserved DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Reboot DB Instance

`<rds:reboot-db-instance>`

This operation reboots a DB instance restarts the database engine service.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Force Failover</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When true, the reboot will be conducted through a MultiAZ failover.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Restore DB Instance From DB Snapshot

`<rds:restore-db-instance-from-db-snapshot>`

Creates a new DB instance from a DB snapshot. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The EC2 Availability Zone that the database instance will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Amazon RDS DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the DB instance to create from the DB snapshot. This parameter isn’t case-sensitive.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the DB snapshot to restore from.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database name for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specify the Active Directory Domain to restore the instance in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database engine to use for the new instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the DB instance is a Multi-AZ deployment.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the option group to use for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number on which the database accepts connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Restore DB Instance To Point In Time

`<rds:restore-db-instance-to-point-in-time>`

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.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The EC2 Availability Zone that the database instance will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Amazon RDS DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database name for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specify the Active Directory Domain to restore the instance in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database engine to use for the new instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the DB instance is a Multi-AZ deployment.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the option group to use for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number on which the database accepts connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Restore Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The date and time to restore from.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the source DB instance from which to restore.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the new database instance to be created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Use Latest Restorable Time</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Start DB Instance

`<rds:start-db-instance>`

Starts a DB instance that was stopped using the AWS console, the `stop-db-instance` AWS CLI command,
or the Stop DB Instance action.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Stop DB Instance

`<rds:stop-db-instance>`

This operation stops a DB instance.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Authentication Types

### TLS

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Types

## Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

## Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Instance

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Ca Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Character Set Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags To Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Cluster Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Parameter Groups</strong></p></td><td><div><div><p>Array of <a href="#DBParameterGroupStatus">DB Parameter Group Status</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Security Groups</strong></p></td><td><div><div><p>Array of <a href="#DBSecurityGroupMembership">DB Security Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Subnet Group</strong></p></td><td><div><div><p><a href="#DBSubnetGroup">DB Subnet Group</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Dbi Resource Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain Memberships</strong></p></td><td><div><div><p>Array of <a href="#DomainMembership">Domain Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Endpoint</strong></p></td><td><div><div><p><a href="#Endpoint">Endpoint</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enhanced Monitoring Resource Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iam Database Authentication Enabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Instance Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Latest Restorable Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Memberships</strong></p></td><td><div><div><p>Array of <a href="#OptionGroupMembership">Option Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pending Modified Values</strong></p></td><td><div><div><p><a href="#PendingModifiedValues">Pending Modified Values</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica DB Cluster Identifiers</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica DB Instance Identifiers</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Secondary Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status Infos</strong></p></td><td><div><div><p>Array of <a href="#DBInstanceStatusInfo">DB Instance Status Info</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tde Credential Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timezone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Security Groups</strong></p></td><td><div><div><p>Array of <a href="#VpcSecurityGroupMembership">VPC Security Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Parameter Group Status

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Parameter Apply Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Security Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Security Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Subnet Group

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Subnet Group Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Group Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnets</strong></p></td><td><div><div><p>Array of <a href="#Subnet">Subnet</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Subnet

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Subnet Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Domain Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>FQDN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Endpoint

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Address</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Hosted Zone Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Option Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Pending Modified Values

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>CA Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Instance Status Info

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Normal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### VPC Security Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Security Group Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Tag

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Snapshot

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Snapshot Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iam Database Authentication Enabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Instance Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Percent Progress</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Region</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tde Credential Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timezone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Request ID Attribute

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Request Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Filter

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Values</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Event

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Date</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Event Categories</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Reserved DB Instance

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Currency Code</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fixed Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charges</strong></p></td><td><div><div><p>Array of <a href="#RecurringCharge">Recurring Charge</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Start Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>State</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Usage Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Recurring Charge

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Recurring Charge Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charge Frequency</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Reserved DB Instances Offering

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Currency Code</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fixed Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charges</strong></p></td><td><div><div><p>Array of <a href="#RecurringCharge">Recurring Charge</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Usage Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=fe6b09ad7bf398282a0e847c10f3d7c2c229ab5df3e0f0073b3efdc7ebd1d828 url=/mulesoft/current/en-us/amazon-rds-connector/1.3/amazon-rds-connector-reference.md -->

---
product: Amazon RDS Connector
version: 1.3
---

# Amazon RDS Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

Amazon RDS Connector v1.3

Anypoint Connector for Amazon RDS (Amazon RDS Connector) provides connectivity to the Amazon
Relational Database Service (Amazon RDS) API, enabling you to interface with Amazon RDS to provide
cost-efficient and resizable capacity while automating time-consuming administration tasks such as
hardware provisioning, database setup, patching and backups.

Release Notes:
[Amazon RDS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-rds-connector-release-notes-mule-4)

## Configurations

---

### Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#config_basic">Basic</a></p></li><li><p><a href="#config_role">Role</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Connection Types

### Basic

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Session Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The session token provided by Amazon STS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to true to obtain credentials from the AWS environment, See`https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html`</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Set the topic region endpoint.</p></div></div></td><td><div><div><p>US_EAST_1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Role

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Role ARN unique identifies role to assume to gain cross account access.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Sets the maximum number of allowed open HTTP connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Socket Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.</p></div></div></td><td><div><div><p>50000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The access key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Secret Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secret key provided by Amazon.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Try Default AWSCredentials Provider Chain</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this field to true to obtain credentials from the AWS environment, See`https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html`</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Set the topic region endpoint.</p></div></div></td><td><div><div><p>US_EAST_1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy host.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The optional proxy port.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy username.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy password.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy domain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Workstation</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The optional proxy workstation.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Operations

- [Create DB Instance](#createDbInstance)

- [Create DB Instance Read Replica](#createDbInstanceReadReplica)

- [Create DB Snapshot](#createDbSnapshot)

- [Delete DB Instance](#deleteDbInstance)

- [Delete DB Snapshot](#deleteDbSnapshot)

- [Describe DB Instances](#describeDbInstances)

- [Describe DB Snapshots](#describeDbSnapshots)

- [Describe Events](#describeEvents)

- [Describe Reserved DB Instances](#describeReservedDbInstances)

- [Describe Reserved DB Instances Offerings](#describeReservedDbInstancesOfferings)

- [Modify DB Instance](#modifyDbInstance)

- [Modify DB Snapshot](#modifyDbSnapshot)

- [Purchase Reserved DB Instances Offering](#purchaseReservedDbInstancesOffering)

- [Reboot DB Instance](#rebootDbInstance)

- [Restore DB Instance From DB Snapshot](#restoreDbInstanceFromDbSnapshot)

- [Restore DB Instance To Point In Time](#restoreDbInstanceToPointInTime)

- [Start DB Instance](#startDbInstance)

- [Stop DB Instance](#stopDbInstance)

## Create DB Instance

`<rds:create-db-instance>`

This operation creates a new database instance.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Cluster Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Security Groups</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>VPC Security Group IDs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>KMS Key ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Port Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Character Set Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Create DB Instance Read Replica

`<rds:create-db-instance-read-replica>`

This operation creates a new DB instance that acts as a Read Replica for an existing source DB
instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.

Amazon Aurora does not support this action. You must call the `CreateDBInstance` action to create a
DB instance for an Aurora DB cluster.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies the accessibility options for the DB instance.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a DB subnet group for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>KMS Key ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The AWS KMS key ID for an encrypted Read Replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pre-Signed URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL that contains a Signature Version 4 signed request for the create-db-instance-read-replica API action in the source AWS Region that contains the source DB instance</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this parameter to <code>true</code> to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier of the Read Replica.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the DB instance that will act as the source for the Read Replica.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Read Replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Amazon EC2 Availability Zone that the Read Replica will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number that the DB instance uses for connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The option group the DB instance will be associated with.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Region</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the region that contains the source for the read replica.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Create DB Snapshot

`<rds:create-db-snapshot>`

This operation creates a DBSnapshot. The source DBInstance must be in the "available" state.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier. The unique key that identifies a DB instance.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the DB snapshot.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Delete DB Instance

`<rds:delete-db-instance>`

The Delete DB Instance action deletes a previously provisioned DB instance. For more information,
see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier for the DB instance to be deleted. This parameter isn’t case-sensitive.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Final DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Final Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether a final DB snapshot is created before the DB instance is deleted.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Delete DB Snapshot

`<rds:delete-db-snapshot>`

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DBSnapshot identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Describe DB Instances

`<rds:describe-db-instances>`

Returns information about provisioned RDS instances. This API supports pagination. For more
information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Filters</strong></p></td><td><div><div><p>Array of <a href="#Filter">Filter</a></p></div></div></td><td><div><div><p>A filter that specifies one or more DB instances to describe.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure if repeatable streams should be used and their behavior</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable on which the operation’s output will be placed</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Array of Message of <a href="#DBInstance">DB Instance</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Describe DB Snapshots

`<rds:describe-db-snapshots>`

Returns information about DB snapshots. This API action supports pagination. For more information,
see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshots.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the DB instance to retrieve the list of DB snapshots for.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Public</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Shared</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of snapshots to be returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Records</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of records to include in the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Filters</strong></p></td><td><div><div><p>Array of <a href="#Filter">Filter</a></p></div></div></td><td><div><div><p>This parameter is not currently supported.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of <a href="#DBSnapshot">DB Snapshot</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Describe Events

`<rds:describe-events>`

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups
for the past 14 days. Events specific to a particular DB instance, DB security group, database
snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default,
the past hour of events are returned. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of minutes to retrieve events for.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>End Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Event Categories</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>A list of event categories that trigger notifications for a event notification subscription.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The event source to retrieve events for. If no value is specified, all events are returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Start Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of <a href="#Event">Event</a> payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Describe Reserved DB Instances

`<rds:describe-reserved-db-instances>`

Returns information about reserved DB instances for this account, or about a specified reserved DB
instance. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstances.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reserved DB Instance ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The reserved DB instance identifier filter value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The product description filter value. Specify this parameter to show only those reservations matching the specified product description.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of [<a href="#ReservedDBInstance">Reserved DB Instance</a>] payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

### Describe Reserved DB Instances Offerings

`<rds:describe-reserved-db-instances-offerings>`

Lists available reserved DB instance offerings. For more information, see this operation in the
Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeReservedDBInstancesOfferings.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of [<a href="#ReservedDBInstancesOffering">Reserved DB Instances Offering</a>] payload and <a href="#RequestIDAttribute">Request ID Attribute</a> attributes</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Modify DB Instance

`<rds:modify-db-instance>`

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. For more information, see this
operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Major Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Apply Immediately</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Security Groups</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>VPC Security Group IDs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>CA Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Port Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>New DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Modify DB Snapshot

`<rds:modify-db-snapshot>`

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
You can update the engine version to either a new major or minor engine version.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the DB snapshot to modify.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The engine version to update the DB snapshot to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBSnapshot">DB Snapshot</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Purchase Reserved DB Instances Offering

`<rds:purchase-reserved-db-instances-offering>`

Purchases a reserved DB instance offering. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PurchaseReservedDBInstancesOffering.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the Reserved DB instance offering to purchase.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of instances to reserve.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Customer-specified identifier to track this reservation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#ReservedDBInstance">Reserved DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Reboot DB Instance

`<rds:reboot-db-instance>`

This operation reboots a DB instance restarts the database engine service.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The DB instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Force Failover</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When true, the reboot will be conducted through a MultiAZ failover.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Restore DB Instance From DB Snapshot

`<rds:restore-db-instance-from-db-snapshot>`

Creates a new DB instance from a DB snapshot. For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The EC2 Availability Zone that the database instance will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Amazon RDS DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the DB instance to create from the DB snapshot. This parameter isn’t case-sensitive.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier for the DB snapshot to restore from.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database name for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specify the Active Directory Domain to restore the instance in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database engine to use for the new instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the DB instance is a Multi-AZ deployment.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the option group to use for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number on which the database accepts connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Restore DB Instance To Point In Time

`<rds:restore-db-instance-to-point-in-time>`

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.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceToPointInTime.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The EC2 Availability Zone that the database instance will be created in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The compute and memory capacity of the Amazon RDS DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database name for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specify the Active Directory Domain to restore the instance in.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The database engine to use for the new instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IOPS</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the DB instance is a Multi-AZ deployment.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the option group to use for the restored DB instance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number on which the database accepts connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Restore Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>The date and time to restore from.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of the source DB instance from which to restore.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Tags</strong></p></td><td><div><div><p>Array of <a href="#Tag">Tag</a></p></div></div></td><td><div><div><p>A list of tags.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the new database instance to be created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Use Latest Restorable Time</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags to Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable IAM Database Authentication</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential ARN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TDE Credential Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Start DB Instance

`<rds:start-db-instance>`

Starts a DB instance that was stopped using the AWS console, the `stop-db-instance` AWS CLI command,
or the Stop DB Instance action.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Stop DB Instance

`<rds:stop-db-instance>`

This operation stops a DB instance.

For more information, see this operation in the Amazon
[API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StopDBInstance.html).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#DBInstance">DB Instance</a></p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:ACCESS\_DENIED\_EXCEPTION

- RDS:AUTHORIZATION\_NOT\_FOUND

- RDS:CERTIFICATE\_NOT\_FOUND

- RDS:CONNECTIVITY

- RDS:DB\_CLUSTER\_NOT\_FOUND\_FAULT

- RDS:DB\_INSTANCE\_ALREADY\_EXISTS

- RDS:DB\_INSTANCE\_NOT\_FOUND

- RDS:DB\_PARAMETER\_GROUP\_NOT\_FOUND

- RDS:DB\_SECURITY\_GROUP\_NOT\_FOUND

- RDS:DB\_SNAPSHOT\_ALREADY\_EXISTS

- RDS:DB\_SNAPSHOT\_NOT\_FOUND

- RDS:DB\_SUBNET\_GROUP\_DOES\_NOT\_COVER\_ENOUGH\_A\_ZS

- RDS:DB\_SUBNET\_GROUP\_NOT\_FOUND\_FAULT

- RDS:DB\_UPGRADE\_DEPENDENCY\_FAILURE

- RDS:DOMAIN\_NOT\_FOUND\_FAULT

- RDS:INCOMPLETE\_SIGNATURE

- RDS:INSTANCE\_QUOTA\_EXCEEDED

- RDS:INSUFFICIENT\_DB\_INSTANCE\_CAPACITY

- RDS:INTERNAL\_FAILURE

- RDS:INVALID\_ACTION

- RDS:INVALID\_CLIENT\_TOKEN\_ID

- RDS:INVALID\_DB\_CLUSTER\_STATE\_FAULT

- RDS:INVALID\_DB\_INSTANCE\_STATE

- RDS:INVALID\_DB\_SECURITY\_GROUP\_STATE

- RDS:INVALID\_DB\_SNAPSHOT\_STATE

- RDS:INVALID\_PARAMETER\_COMBINATION

- RDS:INVALID\_PARAMETER\_VALUE

- RDS:INVALID\_QUERY\_PARAMETER

- RDS:INVALID\_RESTORE\_FAULT

- RDS:INVALID\_SUBNET

- RDS:INVALID\_VPC\_NETWORK\_STATE\_FAULT

- RDS:KMS\_KEY\_NOT\_ACCESSIBLE\_FAULT

- RDS:MALFORMED\_QUERY\_STRING

- RDS:MISSING\_ACTION

- RDS:MISSING\_AUTHENTICATION\_TOKEN

- RDS:MISSING\_PARAMETER

- RDS:OPT\_IN\_REQUIRED

- RDS:OPTION\_GROUP\_NOT\_FOUND\_FAULT

- RDS:POINT\_IN\_TIME\_RESTORE\_NOT\_ENABLED

- RDS:PROVISIONED\_IOPS\_NOT\_AVAILABLE\_IN\_AZ\_FAULT

- RDS:REQUEST\_EXPIRED

- RDS:RESERVED\_DB\_INSTANCE\_NOT\_FOUND

- RDS:RESERVED\_DB\_INSTANCES\_OFFERING\_NOT\_FOUND

- RDS:RETRY\_EXHAUSTED

- RDS:SERVICE\_UNAVAILABLE

- RDS:SNAPSHOT\_QUOTA\_EXCEEDED

- RDS:STORAGE\_QUOTA\_EXCEEDED

- RDS:STORAGE\_TYPE\_NOT\_SUPPORTED

- RDS:THROTTLING\_EXCEPTION

- RDS:UNKNOWN

- RDS:VALIDATION\_ERROR

## Authentication Types

### TLS

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- RDS:AccessDeniedException

- RDS:AuthorizationNotFound

- RDS:CertificateNotFound

- RDS:CONNECTIVITY

- RDS:DBClusterNotFoundFault

- RDS:DBInstanceAlreadyExists

- RDS:DBInstanceNotFound

- RDS:DBParameterGroupNotFound

- RDS:DBSecurityGroupNotFound

- RDS:DBSnapshotAlreadyExists

- RDS:DBSnapshotNotFound

- RDS:DBSubnetGroupDoesNotCoverEnoughAZs

- RDS:DBSubnetGroupNotFoundFault

- RDS:DBUpgradeDependencyFailure

- RDS:DomainNotFoundFault

- RDS:IncompleteSignature

- RDS:InstanceQuotaExceeded

- RDS:InsufficientDBInstanceCapacity

- RDS:InternalFailure

- RDS:InvalidAction

- RDS:InvalidClientTokenId

- RDS:InvalidDBClusterStateFault

- RDS:InvalidDBInstanceState

- RDS:InvalidDBSecurityGroupState

- RDS:InvalidDBSnapshotState

- RDS:InvalidParameterCombination

- RDS:InvalidParameterValue

- RDS:InvalidQueryParameter

- RDS:InvalidRestoreFault

- RDS:InvalidSubnet

- RDS:InvalidVPCNetworkStateFault

- RDS:KMSKeyNotAccessibleFault

- RDS:MalformedQueryString

- RDS:MissingAction

- RDS:MissingAuthenticationToken

- RDS:MissingParameter

- RDS:OptInRequired

- RDS:OptionGroupNotFoundFault

- RDS:PointInTimeRestoreNotEnabled

- RDS:ProvisionedIopsNotAvailableInAZFault

- RDS:RequestExpired

- RDS:ReservedDBInstanceNotFound

- RDS:ReservedDBInstancesOfferingNotFound

- RDS:RETRY\_EXHAUSTED

- RDS:ServiceUnavailable

- RDS:SnapshotQuotaExceeded

- RDS:StorageQuotaExceeded

- RDS:StorageTypeNotSupported

- RDS:ThrottlingException

- RDS:Unknown

- RDS:ValidationError

## Types

## Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

## Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Instance

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Minor Version Upgrade</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Ca Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Character Set Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Tags To Snapshot</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Cluster Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Parameter Groups</strong></p></td><td><div><div><p>Array of <a href="#DBParameterGroupStatus">DB Parameter Group Status</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Security Groups</strong></p></td><td><div><div><p>Array of <a href="#DBSecurityGroupMembership">DB Security Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Subnet Group</strong></p></td><td><div><div><p><a href="#DBSubnetGroup">DB Subnet Group</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Dbi Resource Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain Memberships</strong></p></td><td><div><div><p>Array of <a href="#DomainMembership">Domain Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Endpoint</strong></p></td><td><div><div><p><a href="#Endpoint">Endpoint</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enhanced Monitoring Resource Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iam Database Authentication Enabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Instance Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Latest Restorable Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Interval</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Monitoring Role Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Memberships</strong></p></td><td><div><div><p>Array of <a href="#OptionGroupMembership">Option Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pending Modified Values</strong></p></td><td><div><div><p><a href="#PendingModifiedValues">Pending Modified Values</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Backup Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Maintenance Window</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Promotion Tier</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Publicly Accessible</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica DB Cluster Identifiers</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica DB Instance Identifiers</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Replica Source DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Secondary Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status Infos</strong></p></td><td><div><div><p>Array of <a href="#DBInstanceStatusInfo">DB Instance Status Info</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tde Credential Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timezone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Security Groups</strong></p></td><td><div><div><p>Array of <a href="#VpcSecurityGroupMembership">VPC Security Group Membership</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Parameter Group Status

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Parameter Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Parameter Apply Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Security Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Security Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Subnet Group

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Subnet Group Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Group Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnets</strong></p></td><td><div><div><p>Array of <a href="#Subnet">Subnet</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Subnet

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Subnet Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Subnet Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Domain Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>FQDN</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IAM Role Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Endpoint

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Address</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Hosted Zone Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Option Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Pending Modified Values

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>CA Certificate Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>DB Subnet Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Backup Retention Period</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master User Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Instance Status Info

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Normal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### VPC Security Group Membership

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Security Group Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Tag

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## DB Snapshot

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Allocated Storage</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Availability Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Snapshot Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encrypted</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Engine Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iam Database Authentication Enabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Instance Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Iops</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>License Model</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Master Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Option Group Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Percent Progress</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Create Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Snapshot Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source DB Snapshot Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Region</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Status</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Storage Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Tde Credential Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timezone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Vpc Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Request ID Attribute

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Request Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Filter

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Values</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Event

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Date</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Event Categories</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Identifier</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Source Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Reserved DB Instance

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Currency Code</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Db Instance Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fixed Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charges</strong></p></td><td><div><div><p>Array of <a href="#RecurringCharge">Recurring Charge</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance Arn</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instance Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Start Time</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>State</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Usage Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Recurring Charge

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Recurring Charge Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charge Frequency</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Reserved DB Instances Offering

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>DB Instance Class</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Currency Code</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Duration</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Fixed Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Multi AZ</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Offering Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Product Description</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recurring Charges</strong></p></td><td><div><div><p>Array of <a href="#RecurringCharge">Recurring Charge</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reserved DB Instances Offering Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Usage Price</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)