String
Amazon RDS Connector Reference - Mule 4
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. |
Amazon RDS Connector v1.3
Anypoint Connector for Amazon RDS (Amazon RDS Connector) provides connectivity to the Amazon Relational Database Service (Amazon RDS) API, enabling you to interface with Amazon RDS to provide cost-efficient and resizable capacity while automating time-consuming administration tasks such as hardware provisioning, database setup, patching and backups.
Release Notes: Amazon RDS Connector Release Notes
Configurations
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
The name for this configuration. Connectors reference the configuration with this name. |
x |
||
Connection |
The connection types to provide to this configuration. |
x |
||
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Session Token |
String |
The session token provided by Amazon STS. |
||
Connection Timeout |
Number |
The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Max Connections |
Number |
Sets the maximum number of allowed open HTTP connections. |
||
Socket Timeout |
Number |
The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Access Key |
String |
The access key provided by Amazon. |
x |
|
Secret Key |
String |
The secret key provided by Amazon. |
x |
|
Try Default AWSCredentials Provider Chain |
Boolean |
Set this field to true to obtain credentials from the AWS environment, See`https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html` |
false |
|
Region Endpoint |
String |
Set the topic region endpoint. |
US_EAST_1 |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy |
|||
Host |
String |
The optional proxy host. |
||
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. |
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Role ARN |
String |
The Role ARN unique identifies role to assume to gain cross account access. |
x |
|
Connection Timeout |
Number |
The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Max Connections |
Number |
Sets the maximum number of allowed open HTTP connections. |
||
Socket Timeout |
Number |
The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Access Key |
String |
The access key provided by Amazon. |
x |
|
Secret Key |
String |
The secret key provided by Amazon. |
x |
|
Try Default AWSCredentials Provider Chain |
Boolean |
Set this field to true to obtain credentials from the AWS environment, See`https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html` |
false |
|
Region Endpoint |
String |
Set the topic region endpoint. |
US_EAST_1 |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy |
|||
Host |
String |
The optional proxy host. |
||
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. |
Create DB Instance
<rds:create-db-instance>
This operation creates a new database instance.
For more information, see this operation in the Amazon API Reference.
Parameters
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Create DB Instance Read Replica
<rds:create-db-instance-read-replica>
This operation creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.
Amazon Aurora does not support this action. You must call the CreateDBInstance
action to create a DB instance for an Aurora DB cluster.
For more information, see this operation in the Amazon API Reference.
Parameters
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. |
|
|
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 |
Set this parameter to |
|
|
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 |
|
||
Copy Tags to Snapshot |
Boolean |
|
||
Storage Type |
String |
|||
Monitoring Interval |
Number |
|||
Monitoring Role ARN |
String |
|||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Create DB Snapshot
<rds:create-db-snapshot>
This operation creates a DBSnapshot. The source DBInstance must be in the "available" state.
For more information, see this operation in the Amazon API Reference.
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. 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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Delete DB Instance
<rds:delete-db-instance>
The Delete DB Instance action deletes a previously provisioned DB instance. For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Delete DB Snapshot
<rds:delete-db-snapshot>
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Describe DB Instances
<rds:describe-db-instances>
Returns information about provisioned RDS instances. This API supports pagination. For more information, see this operation in the Amazon API Reference.
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. |
||
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
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 |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Describe DB Snapshots
<rds:describe-db-snapshots>
Returns information about DB snapshots. This API action supports pagination. For more information, see this operation in the Amazon API Reference.
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. |
||
Max Records |
Number |
The maximum number of records to include in the response. |
||
Filters |
Array of Filter |
This parameter is not currently supported. |
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of DB Snapshot payload and Request ID Attribute attributes |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Describe Events
<rds:describe-events>
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. For more information, see this operation in the Amazon API Reference.
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 |
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 to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of Event payload and Request ID Attribute attributes |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Describe Reserved DB Instances
<rds:describe-reserved-db-instances>
Returns information about reserved DB instances for this account, or about a specified reserved DB instance. For more information, see this operation in the Amazon API Reference.
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 |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
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 |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Describe Reserved DB Instances Offerings
<rds:describe-reserved-db-instances-offerings>
Lists available reserved DB instance offerings. For more information, see this operation in the Amazon API Reference.
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. |
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
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 |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Modify DB Instance
<rds:modify-db-instance>
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information, see this operation in the Amazon API Reference.
Parameters
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Modify DB Snapshot
<rds:modify-db-snapshot>
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. You can update the engine version to either a new major or minor engine version.
For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Purchase Reserved DB Instances Offering
<rds:purchase-reserved-db-instances-offering>
Purchases a reserved DB instance offering. For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Reboot DB Instance
<rds:reboot-db-instance>
This operation reboots a DB instance restarts the database engine service.
For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Restore DB Instance From DB Snapshot
<rds:restore-db-instance-from-db-snapshot>
Creates a new DB instance from a DB snapshot. For more information, see this operation in the Amazon API Reference.
Parameters
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 use 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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Restore DB Instance To Point In Time
<rds:restore-db-instance-to-point-in-time>
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
For more information, see this operation in the Amazon API Reference.
Parameters
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 use 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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Start DB Instance
<rds:start-db-instance>
Starts a DB instance that was stopped using the AWS console, the stop-db-instance
AWS CLI command, or the Stop DB Instance action.
For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
Stop DB Instance
<rds:stop-db-instance>
This operation stops a DB instance.
For more information, see this operation in the Amazon API Reference.
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 to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
RDS:ACCESS_DENIED_EXCEPTION
-
RDS:AUTHORIZATION_NOT_FOUND
-
RDS:CERTIFICATE_NOT_FOUND
-
RDS:CONNECTIVITY
-
RDS:DB_CLUSTER_NOT_FOUND_FAULT
-
RDS:DB_INSTANCE_ALREADY_EXISTS
-
RDS:DB_INSTANCE_NOT_FOUND
-
RDS:DB_PARAMETER_GROUP_NOT_FOUND
-
RDS:DB_SECURITY_GROUP_NOT_FOUND
-
RDS:DB_SNAPSHOT_ALREADY_EXISTS
-
RDS:DB_SNAPSHOT_NOT_FOUND
-
RDS:DB_SUBNET_GROUP_DOES_NOT_COVER_ENOUGH_A_ZS
-
RDS:DB_SUBNET_GROUP_NOT_FOUND_FAULT
-
RDS:DB_UPGRADE_DEPENDENCY_FAILURE
-
RDS:DOMAIN_NOT_FOUND_FAULT
-
RDS:INCOMPLETE_SIGNATURE
-
RDS:INSTANCE_QUOTA_EXCEEDED
-
RDS:INSUFFICIENT_DB_INSTANCE_CAPACITY
-
RDS:INTERNAL_FAILURE
-
RDS:INVALID_ACTION
-
RDS:INVALID_CLIENT_TOKEN_ID
-
RDS:INVALID_DB_CLUSTER_STATE_FAULT
-
RDS:INVALID_DB_INSTANCE_STATE
-
RDS:INVALID_DB_SECURITY_GROUP_STATE
-
RDS:INVALID_DB_SNAPSHOT_STATE
-
RDS:INVALID_PARAMETER_COMBINATION
-
RDS:INVALID_PARAMETER_VALUE
-
RDS:INVALID_QUERY_PARAMETER
-
RDS:INVALID_RESTORE_FAULT
-
RDS:INVALID_SUBNET
-
RDS:INVALID_VPC_NETWORK_STATE_FAULT
-
RDS:KMS_KEY_NOT_ACCESSIBLE_FAULT
-
RDS:MALFORMED_QUERY_STRING
-
RDS:MISSING_ACTION
-
RDS:MISSING_AUTHENTICATION_TOKEN
-
RDS:MISSING_PARAMETER
-
RDS:OPT_IN_REQUIRED
-
RDS:OPTION_GROUP_NOT_FOUND_FAULT
-
RDS:POINT_IN_TIME_RESTORE_NOT_ENABLED
-
RDS:PROVISIONED_IOPS_NOT_AVAILABLE_IN_AZ_FAULT
-
RDS:REQUEST_EXPIRED
-
RDS:RESERVED_DB_INSTANCE_NOT_FOUND
-
RDS:RESERVED_DB_INSTANCES_OFFERING_NOT_FOUND
-
RDS:RETRY_EXHAUSTED
-
RDS:SERVICE_UNAVAILABLE
-
RDS:SNAPSHOT_QUOTA_EXCEEDED
-
RDS:STORAGE_QUOTA_EXCEEDED
-
RDS:STORAGE_TYPE_NOT_SUPPORTED
-
RDS:THROTTLING_EXCEPTION
-
RDS:UNKNOWN
-
RDS:VALIDATION_ERROR
Authentication Types
TLS
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
CRL File
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The path to the CRL file. |
Throws
-
RDS:AccessDeniedException
-
RDS:AuthorizationNotFound
-
RDS:CertificateNotFound
-
RDS:CONNECTIVITY
-
RDS:DBClusterNotFoundFault
-
RDS:DBInstanceAlreadyExists
-
RDS:DBInstanceNotFound
-
RDS:DBParameterGroupNotFound
-
RDS:DBSecurityGroupNotFound
-
RDS:DBSnapshotAlreadyExists
-
RDS:DBSnapshotNotFound
-
RDS:DBSubnetGroupDoesNotCoverEnoughAZs
-
RDS:DBSubnetGroupNotFoundFault
-
RDS:DBUpgradeDependencyFailure
-
RDS:DomainNotFoundFault
-
RDS:IncompleteSignature
-
RDS:InstanceQuotaExceeded
-
RDS:InsufficientDBInstanceCapacity
-
RDS:InternalFailure
-
RDS:InvalidAction
-
RDS:InvalidClientTokenId
-
RDS:InvalidDBClusterStateFault
-
RDS:InvalidDBInstanceState
-
RDS:InvalidDBSecurityGroupState
-
RDS:InvalidDBSnapshotState
-
RDS:InvalidParameterCombination
-
RDS:InvalidParameterValue
-
RDS:InvalidQueryParameter
-
RDS:InvalidRestoreFault
-
RDS:InvalidSubnet
-
RDS:InvalidVPCNetworkStateFault
-
RDS:KMSKeyNotAccessibleFault
-
RDS:MalformedQueryString
-
RDS:MissingAction
-
RDS:MissingAuthenticationToken
-
RDS:MissingParameter
-
RDS:OptInRequired
-
RDS:OptionGroupNotFoundFault
-
RDS:PointInTimeRestoreNotEnabled
-
RDS:ProvisionedIopsNotAvailableInAZFault
-
RDS:RequestExpired
-
RDS:ReservedDBInstanceNotFound
-
RDS:ReservedDBInstancesOfferingNotFound
-
RDS:RETRY_EXHAUSTED
-
RDS:ServiceUnavailable
-
RDS:SnapshotQuotaExceeded
-
RDS:StorageQuotaExceeded
-
RDS:StorageTypeNotSupported
-
RDS:ThrottlingException
-
RDS:Unknown
-
RDS:ValidationError
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 fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
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 |
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 |
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 |
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
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 |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
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 |