Configurations
Configuration
Parameters
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 will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |
|
Connection Types
Basic
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
The optional proxy port |
|
|
Port |
Number |
The optional proxy port |
|
|
Username |
String |
The optional proxy username |
|
|
Password |
String |
The optional proxy password |
|
|
Domain |
String |
The optional proxy domain |
|
|
Workstation |
String |
The optional proxy workstation |
|
|
Socket Timeout |
Number |
The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended. |
50000 |
|
Connection Timeout |
Number |
The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended. |
50000 |
|
Max Connections |
Number |
Sets the maximum number of allowed open HTTP connections. |
50 |
|
Region Endpoint |
Enumeration, one of:
|
Region to be set for the amazon rds client |
|
|
accessKey |
String |
x |
||
secretKey |
String |
x |
||
Try Default AWSCredentials Provider Chain |
Boolean |
false |
|
|
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 |
|
Associated Operations
Operations
Create Db Instance
<rds:create-db-instance>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Allocated Storage |
Number |
The amount of storage (in gigabytes) to be initially allocated for the database instance. |
|
|
Auto Minor Version Upgrade |
Boolean |
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. |
false |
|
Availability Zone |
String |
The EC2 Availability Zone that the database instance will be created in. |
|
|
Backup Retention Period |
Number |
The number of days for which automated backups are retained. |
|
|
Character Set Name |
String |
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. |
|
|
Copy Tags to Snapshot |
Boolean |
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. |
false |
|
DB Cluster Identifier |
String |
The identifier of the DB cluster that the instance will belong to. |
|
|
DB Instance Class |
String |
The compute and memory capacity of the DB instance. |
x |
|
DB Instance Identifier |
String |
The DB instance identifier. This parameter is stored as a lowercase string. |
x |
|
DB Name |
String |
The meaning of this parameter differs according to the database engine you use. |
|
|
DB Parameter Group Name |
String |
The name of the DB parameter group to associate with this DB instance |
|
|
DB Security Groups |
Array of String |
A list of DB security groups to associate with this DB instance. |
|
|
DB Subnet Group Name |
String |
A DB subnet group to associate with this DB instance. |
|
|
Domain |
String |
Specify the Active Directory Domain to create the instance in. |
|
|
Domain IAM Role Name |
String |
Specify the name of the IAM role to be used when making API calls to the Directory Service. |
|
|
Enable IAM Database Authentication |
Boolean |
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. |
false |
|
Engine |
String |
The name of the database engine to be used for this instance. |
x |
|
Engine Version |
String |
The version number of the database engine to use. |
|
|
IOPS |
Number |
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. |
|
|
KMS Key ID |
String |
The KMS key identifier for an encrypted DB instance. |
|
|
License Model |
String |
License model information for this DB instance. |
|
|
Master User Name |
String |
The name for the master user. |
|
|
Master User Password |
String |
The password for the master user. Can be any printable ASCII character except "/", """, or "@". |
|
|
Monitoring Interval |
Number |
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. |
|
|
Monitoring Role ARN |
String |
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. |
|
|
Multi AZ |
Boolean |
Specifies if the DB instance is a Multi-AZ deployment. |
false |
|
Option Group Name |
String |
Indicates that the DB instance should be associated with the specified option group. |
|
|
Port |
Number |
The port number on which the database accepts connections. |
|
|
Preferred Backup Window |
String |
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. |
|
|
Preferred Maintenance Window |
String |
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
|
|
Promotion Tier |
Number |
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. |
|
|
Publicly Accessible |
Boolean |
Specifies the accessibility options for the DB instance. |
false |
|
Storage Encrypted |
Boolean |
Specifies whether the DB instance is encrypted. |
false |
|
Storage Type |
String |
Specifies the storage type to be associated with the DB instance. |
|
|
Tags |
Array of Tag |
A list of tags. |
|
|
TDE Credential ARN |
String |
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
|
TDE Credential Password |
String |
The password for the given ARN from the Key Store in order to access the device. |
|
|
Time Zone |
String |
The time zone of the DB instance. |
|
|
VPC Security Group IDs |
Array of String |
A list of EC2 VPC security groups to associate with this DB instance. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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. |
|
|
Auto Minor Version Upgrade |
Boolean |
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. |
false |
|
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. |
|
|
Publicly Accessible |
Boolean |
Specifies the accessibility options for the DB instance. |
false |
|
Tags |
Array of Tag |
A list of tags. |
|
|
DB Subnet Group Name |
String |
Specifies a DB subnet group for the DB instance. |
|
|
Storage Type |
String |
Specifies the storage type to be associated with the Read Replica. |
|
|
Copy Tags to Snapshot |
Boolean |
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false. |
false |
|
Monitoring Interval |
Number |
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. |
|
|
Monitoring Role ARN |
String |
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. |
|
|
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 |
|
Source Region |
String |
The ID of the region that contains the source for the read replica. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Create Db Snapshot
<rds:create-db-snapshot>
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Delete Db Instance
<rds:delete-db-instance>
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Delete Db Snapshot
<rds:delete-db-snapshot>
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Describe Db Instances
<rds:describe-db-instances>
Parameters
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. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Describe Db Snapshots
<rds:describe-db-snapshots>
Parameters
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. |
|
|
Filters |
Array of Filter |
This parameter is not currently supported. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
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 |
Date |
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 |
Date |
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
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 |
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Describe Reserved Db Instances Offerings
<rds:describe-reserved-db-instances-offerings>
Lists available reserved DB instance offerings.
Parameters
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. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Allocated Storage |
Number |
The new storage capacity of the RDS instance. |
|
|
Allow Major Version Upgrade |
Boolean |
Indicates that major version upgrades are allowed. |
false |
|
Apply Immediately |
Boolean |
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, |
false |
|
Auto Minor Version Upgrade |
Boolean |
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. |
false |
|
Backup Retention Period |
Number |
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. |
|
|
CA Certificate Identifier |
String |
Indicates the certificate that needs to be associated with the instance. |
|
|
Copy Tags to Snapshot |
Boolean |
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. |
false |
|
DB Instance Class |
String |
The new compute and memory capacity of the DB instance. |
|
|
DB Instance Identifier |
String |
The DB instance identifier. This value is stored as a lowercase string. |
x |
|
DB Parameter Group Name |
String |
The name of the DB parameter group to apply to the DB instance. |
|
|
DB Port Number |
Number |
The port number on which the database accepts connections. |
|
|
DB Security Groups |
Array of String |
A list of DB security groups to authorize on this DB instance. |
|
|
DB Subnet Group Name |
String |
The new DB subnet group for the DB instance. |
|
|
Domain |
String |
The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. |
|
|
Domain IAM Role Name |
String |
The name of the IAM role to use when making API calls to the Directory Service. |
|
|
Enable IAM Database Authentication |
Boolean |
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. |
false |
|
Engine Version |
String |
The version number of the database engine to upgrade to. |
|
|
IOPS |
Number |
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. |
|
|
License Model |
String |
The license model for the DB instance. |
|
|
Master User Password |
String |
The new password for the master user. Can be any printable ASCII character except "/", """, or "@". |
|
|
Monitoring Interval |
Number |
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. |
|
|
Monitoring Role ARN |
String |
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. |
|
|
Multi AZ |
Boolean |
Specifies if the DB instance is a Multi-AZ deployment. |
false |
|
New DB Instance Identifier |
String |
The new DB instance identifier for the DB instance when renaming a DB instance. |
|
|
Option Group Name |
String |
Indicates that the DB instance should be associated with the specified option group. |
|
|
Preferred Backup Window |
String |
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. |
|
|
Preferred Maintenance Window |
String |
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. |
|
|
Promotion Tier |
Number |
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. |
|
|
Publicly Accessible |
Boolean |
Boolean value that indicates if the DB instance has a publicly resolvable DNS name. |
false |
|
Storage Type |
String |
Specifies the storage type to be associated with the DB instance. |
|
|
TDE Credential ARN |
String |
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
|
TDE Credential Password |
String |
The password for the given ARN from the Key Store in order to access the device. |
|
|
VPC Security Group IDs |
Array of String |
A list of EC2 VPC security groups to authorize on this DB instance. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Purchase Reserved Db Instances Offering
<rds:purchase-reserved-db-instances-offering>
Purchases a reserved DB instance offering.
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Reboot Db Instance
<rds:reboot-db-instance>
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Restore Db Instance From Db Snapshot
<rds:restore-db-instance-from-db-snapshot>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Auto Minor Version Upgrade |
Boolean |
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. |
false |
|
Availability Zone |
String |
The EC2 Availability Zone that the database instance will be created in. |
|
|
Copy Tags to Snapshot |
Boolean |
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. |
false |
|
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. |
|
|
DB Subnet Group Name |
String |
The DB subnet group name to use for the new instance. |
|
|
Domain |
String |
Specify the Active Directory Domain to restore the instance in. |
|
|
Domain IAM Role Name |
String |
Specify the name of the IAM role to be used when making API calls to the Directory Service. |
|
|
Enable IAM Database Authentication |
Boolean |
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. |
false |
|
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. |
|
|
License Model |
String |
License model information for the restored 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. |
|
|
Publicly Accessible |
Boolean |
Specifies the accessibility options for the DB instance. |
false |
|
Storage Type |
String |
Specifies the storage type to be associated with the DB instance. |
|
|
Tags |
Array of Tag |
A list of tags. |
|
|
TDE Credential ARN |
String |
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
|
TDE Credential Password |
String |
The password for the given ARN from the Key Store in order to access the device. |
|
|
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Auto Minor Version Upgrade |
Boolean |
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. |
false |
|
Availability Zone |
String |
The EC2 Availability Zone that the database instance will be created in. |
|
|
Copy Tags to Snapshot |
Boolean |
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. |
false |
|
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. |
|
|
DB Subnet Group Name |
String |
The DB subnet group name to use for the new instance. |
|
|
Domain |
String |
Specify the Active Directory Domain to restore the instance in. |
|
|
Domain IAM Role Name |
String |
Specify the name of the IAM role to be used when making API calls to the Directory Service. |
|
|
Enable IAM Database Authentication |
Boolean |
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false |
false |
|
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. |
|
|
License Model |
String |
License model information for the restored 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. |
|
|
Publicly Accessible |
Boolean |
Specifies the accessibility options for the DB instance. |
false |
|
Restore Time |
Date |
The date and time to restore from. |
|
|
Source DB Instance Identifier |
String |
The identifier of the source DB instance from which to restore. |
x |
|
Storage Type |
String |
Specifies the storage type to be associated with the DB instance. |
|
|
Tags |
Array of Tag |
A list of tags. |
|
|
Target DB Instance Identifier |
String |
The name of the new database instance to be created. |
x |
|
TDE Credential ARN |
String |
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
|
TDE Credential Password |
String |
The password for the given ARN from the Key Store in order to access the device. |
|
|
Use Latest Restorable Time |
Boolean |
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time. |
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
Stop Db Instance
<rds:stop-db-instance>
Parameters
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:RETRY_EXHAUSTED
-
RDS:CONNECTIVITY
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:
|
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 |
Array of DB Parameter Group Status |
|||
Db Security Groups |
Array of DB Security Group Membership |
|||
Db Subnet Group |
||||
Dbi Resource Id |
String |
|||
Domain Memberships |
Array of Domain Membership |
|||
Endpoint |
||||
Engine |
String |
|||
Engine Version |
String |
|||
Enhanced Monitoring Resource Arn |
String |
|||
Iam Database Authentication Enabled |
Boolean |
|||
Instance Create Time |
Date |
|||
Iops |
Number |
|||
Kms Key Id |
String |
|||
Latest Restorable Time |
Date |
|||
License Model |
String |
|||
Master Username |
String |
|||
Monitoring Interval |
Number |
|||
Monitoring Role Arn |
String |
|||
Multi AZ |
Boolean |
|||
Option Group Memberships |
Array of Option Group Membership |
|||
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 |
Array of DB Instance Status Info |
|||
Storage Encrypted |
Boolean |
|||
Storage Type |
String |
|||
Tde Credential Arn |
String |
|||
Timezone |
String |
|||
Vpc Security Groups |
Array of Vpc Security Group Membership |
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 |
||||
Subnet Identifier |
String |
|||
Subnet Status |
String |
Availability Zone
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
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 |
Date |
|||
Iops |
Number |
|||
Kms Key Id |
String |
|||
License Model |
String |
|||
Master Username |
String |
|||
Option Group Name |
String |
|||
Percent Progress |
Number |
|||
Port |
Number |
|||
Snapshot Create Time |
Date |
|||
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 |
Describe DB Instances Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Db Instances |
Array of DB Instance |
|||
Marker |
String |
Filter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
|||
Values |
Array of String |
Describe DB Snapshots Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Db Snapshots |
Array of DB Snapshot |
|||
Marker |
String |
Describe Events Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Events |
Array of Event |
|||
Marker |
String |
Event
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Date |
Date |
|||
Event Categories |
Array of String |
|||
Message |
String |
|||
Source Arn |
String |
|||
Source Identifier |
String |
|||
Source Type |
String |
Describe Reserved DB Instances Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Marker |
String |
|||
Reserved DB Instances |
Array of Reserved DB Instance |
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 |
Date |
|||
State |
String |
|||
Usage Price |
Number |
Recurring Charge
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Recurring Charge Amount |
Number |
|||
Recurring Charge Frequency |
String |
Describe Reserved DB Instances Offerings Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Marker |
String |
|||
Reserved DB Instances Offerings |
Array of Reserved DB Instances Offering |
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 |