Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Amazon RDS Connector Reference

Configurations


Configuration

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees it fit.

Connection Types

Basic
Name Type Description Default Value Required

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • US_EAST_1

  • US_EAST_2

  • US_WEST_1

  • US_WEST_2

  • EU_WEST_1

  • EU_WEST_2

  • EU_CENTRAL_1

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • SA_EAST_1

  • CA_CENTRAL_1

  • CN_NORTH_1

  • US_GOV_WEST_1

US_EAST_1

Topic Arn (Only to test connectivity)

String

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Role
Name Type Description Default Value Required

Role ARN

String

x

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • US_EAST_1

  • US_EAST_2

  • US_WEST_1

  • US_WEST_2

  • EU_WEST_1

  • EU_WEST_2

  • EU_CENTRAL_1

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • SA_EAST_1

  • CA_CENTRAL_1

  • CN_NORTH_1

  • US_GOV_WEST_1

US_EAST_1

Topic Arn (Only to test connectivity)

String

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Operations

Create Db Instance

<rds:create-db-instance>

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Auto Minor Version Upgrade

Boolean

false

Copy Tags to Snapshot

Boolean

false

Storage Type

String

Allocated Storage

Number

Backup Retention Period

Number

Preferred Backup Window

String

Preferred Maintenance Window

String

Promotion Tier

Number

Storage Encrypted

Boolean

false

DB Cluster Identifier

String

DB Subnet Group Name

String

Domain IAM Role Name

String

Enable IAM Database Authentication

Boolean

false

License Model

String

Publicly Accessible

Boolean

false

TDE Credential ARN

String

TDE Credential Password

String

DB Security Groups

Array of String

Master User Password

String

VPC Security Group IDs

Array of String

Master User Name

String

KMS Key ID

String

Monitoring Interval

Number

Monitoring Role ARN

String

DB Instance Class

String

DB Instance Identifier

String

x

DB Parameter Group Name

String

Domain

String

Engine Version

String

IOPS

Number

Multi AZ

Boolean

false

Option Group Name

String

Availability Zone

String

DB Name

String

DB Port Number

Number

Engine

String

x

Character Set Name

String

Tags

Array of Tag

Time Zone

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Create Db Instance Read Replica

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

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Publicly Accessible

Boolean

Specifies the accessibility options for the DB instance.

false

DB Subnet Group Name

String

Specifies a DB subnet group for the DB instance.

KMS Key ID

String

The AWS KMS key ID for an encrypted Read Replica.

Pre-Signed URL

String

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

Enable IAM Database Authentication

Boolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

false

DB Instance Identifier

String

The DB instance identifier of the Read Replica.

x

Source DB Instance Identifier

String

The identifier of the DB instance that will act as the source for the Read Replica.

x

DB Instance Class

String

The compute and memory capacity of the Read Replica.

Availability Zone

String

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Port

Number

The port number that the DB instance uses for connections.

IOPS

Number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Option Group Name

String

The option group the DB instance will be associated with.

Tags

Array of Tag

A list of tags.

Source Region

String

The ID of the region that contains the source for the read replica.

Auto Minor Version Upgrade

Boolean

false

Copy Tags to Snapshot

Boolean

false

Storage Type

String

Monitoring Interval

Number

Monitoring Role ARN

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Create Db Snapshot

<rds:create-db-snapshot>

Creates a DBSnapshot. The source DBInstance must be in "available" state. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The DB instance identifier. This is the unique key that identifies a DB instance.

x

DB Snapshot Identifier

String

The identifier for the DB snapshot.

x

Tags

Array of Tag

A list of tags.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Delete Db Instance

<rds:delete-db-instance>

The DeleteDBInstance action deletes a previously provisioned DB instance. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The DB instance identifier for the DB instance to be deleted. This parameter isn’t case-sensitive.

x

Final DB Snapshot Identifier

String

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Skip Final Snapshot

Boolean

Determines whether a final DB snapshot is created before the DB instance is deleted.

false

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Delete Db Snapshot

<rds:delete-db-snapshot>

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. View this operation in the Amazon API Refernce.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Snapshot Identifier

String

The DBSnapshot identifier.

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Describe Db Instances

<rds:describe-db-instances>

Returns information about provisioned RDS instances. This API supports pagination. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The user-supplied instance identifier.

Filters

Array of Filter

A filter that specifies one or more DB instances to describe.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [DB Instance] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Describe Db Snapshots

<rds:describe-db-snapshots>

Returns information about DB snapshots. This API action supports pagination. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The ID of the DB instance to retrieve the list of DB snapshots for.

DB Snapshot Identifier

String

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier.

Include Public

Boolean

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.

false

Include Shared

Boolean

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.

false

Snapshot Type

String

The type of snapshots to be returned.

Max Records

Number

Filters

Array of Filter

This parameter is not currently supported.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [DB Snapshot] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Duration

Number

The number of minutes to retrieve events for.

End Time

DateTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Event Categories

Array of String

A list of event categories that trigger notifications for a event notification subscription.

Source Identifier

String

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Source Type

String

The event source to retrieve events for. If no value is specified, all events are returned.

Start Time

DateTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Event] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Reserved DB Instance ID

String

The reserved DB instance identifier filter value.

Reserved DB Instances Offering ID

String

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

DB Instance Class

String

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Duration

String

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Product Description

String

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Offering Type

String

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Multi AZ

Boolean

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

false

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Reserved DB Instance] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Describe Reserved Db Instances Offerings

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

Lists available reserved DB instance offerings. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Class

String

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Duration

String

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Multi AZ

Boolean

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

false

Offering Type

String

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Product Description

String

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

Reserved DB Instances Offering ID

String

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Reserved DB Instances Offering] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Auto Minor Version Upgrade

Boolean

false

Copy Tags to Snapshot

Boolean

false

Storage Type

String

Allocated Storage

Number

Backup Retention Period

Number

Preferred Backup Window

String

Preferred Maintenance Window

String

Promotion Tier

Number

Allow Major Version Upgrade

Boolean

false

Apply Immediately

Boolean

false

DB Subnet Group Name

String

Domain IAM Role Name

String

Enable IAM Database Authentication

Boolean

false

License Model

String

Publicly Accessible

Boolean

false

TDE Credential ARN

String

TDE Credential Password

String

DB Security Groups

Array of String

Master User Password

String

VPC Security Group IDs

Array of String

CA Certificate Identifier

String

Monitoring Interval

Number

Monitoring Role ARN

String

DB Instance Class

String

DB Instance Identifier

String

x

DB Parameter Group Name

String

Domain

String

Engine Version

String

IOPS

Number

Multi AZ

Boolean

false

Option Group Name

String

DB Port Number

Number

New DB Instance Identifier

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Snapshot Identifier

String

The identifier of the DB snapshot to modify.

x

Engine Version

String

The engine version to update the DB snapshot to.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Purchase Reserved Db Instances Offering

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

Purchases a reserved DB instance offering. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Reserved DB Instances Offering ID

String

The ID of the Reserved DB instance offering to purchase.

x

DB Instance Count

Number

The number of instances to reserve.

Reserved DB Instance ID

String

Customer-specified identifier to track this reservation.

Tags

Array of Tag

A list of tags.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Reboot Db Instance

<rds:reboot-db-instance>

Rebooting a DB instance restarts the database engine service. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The DB instance identifier.

x

Force Failover

Boolean

When true, the reboot will be conducted through a MultiAZ failover.

false

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Restore Db Instance From Db Snapshot

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

Creates a new DB instance from a DB snapshot. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Availability Zone

String

The EC2 Availability Zone that the database instance will be created in.

DB Instance Class

String

The compute and memory capacity of the Amazon RDS DB instance.

DB Instance Identifier

String

Name of the DB instance to create from the DB snapshot. This parameter isn’t case-sensitive.

x

DB Snapshot Identifier

String

The identifier for the DB snapshot to restore from.

x

DB Name

String

The database name for the restored DB instance.

Domain

String

Specify the Active Directory Domain to restore the instance in.

Engine

String

The database engine to use for the new instance.

IOPS

Number

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.

Multi AZ

Boolean

Specifies if the DB instance is a Multi-AZ deployment.

false

Option Group Name

String

The name of the option group to be used for the restored DB instance.

Port

Number

The port number on which the database accepts connections.

Tags

Array of Tag

A list of tags.

Auto Minor Version Upgrade

Boolean

false

Copy Tags to Snapshot

Boolean

false

Storage Type

String

DB Subnet Group Name

String

Domain IAM Role Name

String

Enable IAM Database Authentication

Boolean

false

License Model

String

Publicly Accessible

Boolean

false

TDE Credential ARN

String

TDE Credential Password

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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. View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Availability Zone

String

The EC2 Availability Zone that the database instance will be created in.

DB Instance Class

String

The compute and memory capacity of the Amazon RDS DB instance.

DB Name

String

The database name for the restored DB instance.

Domain

String

Specify the Active Directory Domain to restore the instance in.

Engine

String

The database engine to use for the new instance.

IOPS

Number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Multi AZ

Boolean

Specifies if the DB instance is a Multi-AZ deployment.

false

Option Group Name

String

The name of the option group to be used for the restored DB instance.

Port

Number

The port number on which the database accepts connections.

Restore Time

DateTime

The date and time to restore from.

Source DB Instance Identifier

String

The identifier of the source DB instance from which to restore.

x

Tags

Array of Tag

A list of tags.

Target DB Instance Identifier

String

The name of the new database instance to be created.

x

Use Latest Restorable Time

Boolean

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

false

Auto Minor Version Upgrade

Boolean

false

Copy Tags to Snapshot

Boolean

false

Storage Type

String

DB Subnet Group Name

String

Domain IAM Role Name

String

Enable IAM Database Authentication

Boolean

false

License Model

String

Publicly Accessible

Boolean

false

TDE Credential ARN

String

TDE Credential Password

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

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 StopDBInstance action View this operation in the Amazon API Reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The user-supplied instance identifier.

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Stop Db Instance

<rds:stop-db-instance>

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

DB Instance Identifier

String

The user-supplied instance identifier.

x

DB Snapshot Identifier

String

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MissingAction

  • RDS:DBInstanceAlreadyExists

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:InvalidSubnet

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InvalidDBInstanceState

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:InvalidParameterCombination

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBSecurityGroupState

  • RDS:ServiceUnavailable

  • RDS:MissingAuthenticationToken

  • RDS:RETRY_EXHAUSTED

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:DBInstanceNotFound

  • RDS:CONNECTIVITY

  • RDS:InvalidQueryParameter

  • RDS:DomainNotFoundFault

  • RDS:OptionGroupNotFoundFault

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterValue

  • RDS:InternalFailure

  • RDS:DBUpgradeDependencyFailure

  • RDS:AuthorizationNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ValidationError

  • RDS:StorageTypeNotSupported

  • RDS:IncompleteSignature

  • RDS:SnapshotQuotaExceeded

  • RDS:MalformedQueryString

  • RDS:InvalidAction

  • RDS:ThrottlingException

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:InvalidClientTokenId

  • RDS:DBSnapshotNotFound

  • RDS:Unknown

  • RDS:InvalidRestoreFault

  • RDS:AccessDeniedException

  • RDS:DBParameterGroupNotFound

  • RDS:OptInRequired

  • RDS:RequestExpired

  • RDS:InstanceQuotaExceeded

  • RDS:MissingParameter

  • RDS:ReservedDBInstanceNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:StorageQuotaExceeded

  • RDS:InvalidVPCNetworkStateFault

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

DB Instance

Field Type Description Default Value Required

Allocated Storage

Number

Auto Minor Version Upgrade

Boolean

Availability Zone

String

Backup Retention Period

Number

Ca Certificate Identifier

String

Character Set Name

String

Copy Tags To Snapshot

Boolean

Db Cluster Identifier

String

Db Instance Arn

String

Db Instance Class

String

Db Instance Identifier

String

Db Instance Port

Number

Db Instance Status

String

Db Name

String

Db Parameter Groups

Db Security Groups

Db Subnet Group

Dbi Resource Id

String

Domain Memberships

Endpoint

Engine

String

Engine Version

String

Enhanced Monitoring Resource Arn

String

Iam Database Authentication Enabled

Boolean

Instance Create Time

DateTime

Iops

Number

Kms Key Id

String

Latest Restorable Time

DateTime

License Model

String

Master Username

String

Monitoring Interval

Number

Monitoring Role Arn

String

Multi AZ

Boolean

Option Group Memberships

Pending Modified Values

Preferred Backup Window

String

Preferred Maintenance Window

String

Promotion Tier

Number

Publicly Accessible

Boolean

Read Replica DB Cluster Identifiers

Array of String

Read Replica DB Instance Identifiers

Array of String

Read Replica Source DB Instance Identifier

String

Secondary Availability Zone

String

Status Infos

Storage Encrypted

Boolean

Storage Type

String

Tde Credential Arn

String

Timezone

String

Vpc Security Groups

DB Parameter Group Status

Field Type Description Default Value Required

DB Parameter Group Name

String

Parameter Apply Status

String

DB Security Group Membership

Field Type Description Default Value Required

DB Security Group Name

String

Status

String

DB Subnet Group

Field Type Description Default Value Required

DB Subnet Group Arn

String

DB Subnet Group Description

String

DB Subnet Group Name

String

Subnet Group Status

String

Subnets

Array of Subnet

Vpc Id

String

Subnet

Field Type Description Default Value Required

Subnet Availability Zone

String

Subnet Identifier

String

Subnet Status

String

Domain Membership

Field Type Description Default Value Required

FQDN

String

IAM Role Name

String

Domain

String

Status

String

Endpoint

Field Type Description Default Value Required

Address

String

Hosted Zone Id

String

Port

Number

Option Group Membership

Field Type Description Default Value Required

Option Group Name

String

Status

String

Pending Modified Values

Field Type Description Default Value Required

CA Certificate Identifier

String

DB Instance Class

String

DB Instance Identifier

String

DB Subnet Group Name

String

Allocated Storage

Number

Backup Retention Period

Number

Engine Version

String

Iops

Number

License Model

String

Master User Password

String

Multi AZ

Boolean

Port

Number

Storage Type

String

DB Instance Status Info

Field Type Description Default Value Required

Message

String

Normal

Boolean

Status

String

Status Type

String

Vpc Security Group Membership

Field Type Description Default Value Required

Status

String

Vpc Security Group Id

String

Tag

Field Type Description Default Value Required

Key

String

Value

String

DB Snapshot

Field Type Description Default Value Required

Allocated Storage

Number

Availability Zone

String

Db Instance Identifier

String

Db Snapshot Arn

String

Db Snapshot Identifier

String

Encrypted

Boolean

Engine

String

Engine Version

String

Iam Database Authentication Enabled

Boolean

Instance Create Time

DateTime

Iops

Number

Kms Key Id

String

License Model

String

Master Username

String

Option Group Name

String

Percent Progress

Number

Port

Number

Snapshot Create Time

DateTime

Snapshot Type

String

Source DB Snapshot Identifier

String

Source Region

String

Status

String

Storage Type

String

Tde Credential Arn

String

Timezone

String

Vpc Id

String

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Filter

Field Type Description Default Value Required

Name

String

Values

Array of String

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Event

Field Type Description Default Value Required

Date

DateTime

Event Categories

Array of String

Message

String

Source Arn

String

Source Identifier

String

Source Type

String

Reserved DB Instance

Field Type Description Default Value Required

Currency Code

String

Db Instance Class

String

Db Instance Count

Number

Duration

Number

Fixed Price

Number

Multi AZ

Boolean

Offering Type

String

Product Description

String

Recurring Charges

Array of Recurring Charge

Reserved DB Instance Arn

String

Reserved DB Instance Id

String

Reserved DB Instances Offering Id

String

Start Time

DateTime

State

String

Usage Price

Number

Recurring Charge

Field Type Description Default Value Required

Recurring Charge Amount

Number

Recurring Charge Frequency

String

Reserved DB Instances Offering

Field Type Description Default Value Required

DB Instance Class

String

Currency Code

String

Duration

Number

Fixed Price

Number

Multi AZ

Boolean

Offering Type

String

Product Description

String

Recurring Charges

Array of Recurring Charge

Reserved DB Instances Offering Id

String

Usage Price

Number