@datafire/amazonaws_rds
v5.0.0
Published
DataFire integration for Amazon Relational Database Service
Downloads
15
Readme
@datafire/amazonaws_rds
Client library for Amazon Relational Database Service
Installation and Usage
npm install --save @datafire/amazonaws_rds
let amazonaws_rds = require('@datafire/amazonaws_rds').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_rds.AddRoleToDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}).then(data => {
console.log(data);
});
Description
Amazon Relational Database Service Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use. This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide. Amazon RDS API Reference For the alphabetical list of API actions, see API Actions. For the alphabetical list of data types, see Data Types. For a list of common query parameters, see Common Parameters. For descriptions of the error codes, see Common Errors. Amazon RDS User Guide For a summary of the Amazon RDS interfaces, see Available RDS Interfaces. For more information about how to use the Query API, see Using the Query API.
Actions
AddRoleToDBCluster
amazonaws_rds.AddRoleToDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}, context)
Input
Output
Output schema unknown
AddSourceIdentifierToSubscription
amazonaws_rds.AddSourceIdentifierToSubscription({
"SubscriptionName": "",
"SourceIdentifier": ""
}, context)
Input
Output
AddTagsToResource
amazonaws_rds.AddTagsToResource({
"ResourceName": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
ApplyPendingMaintenanceAction
amazonaws_rds.ApplyPendingMaintenanceAction({
"ResourceIdentifier": "",
"ApplyAction": "",
"OptInType": ""
}, context)
Input
Output
AuthorizeDBSecurityGroupIngress
amazonaws_rds.AuthorizeDBSecurityGroupIngress({
"DBSecurityGroupName": ""
}, context)
Input
- input
object
Output
CopyDBClusterParameterGroup
amazonaws_rds.CopyDBClusterParameterGroup({
"SourceDBClusterParameterGroupIdentifier": "",
"TargetDBClusterParameterGroupIdentifier": "",
"TargetDBClusterParameterGroupDescription": ""
}, context)
Input
- input
object
Output
CopyDBClusterSnapshot
amazonaws_rds.CopyDBClusterSnapshot({
"SourceDBClusterSnapshotIdentifier": "",
"TargetDBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
Output
- output CopyDBClusterSnapshotResult
CopyDBParameterGroup
amazonaws_rds.CopyDBParameterGroup({
"SourceDBParameterGroupIdentifier": "",
"TargetDBParameterGroupIdentifier": "",
"TargetDBParameterGroupDescription": ""
}, context)
Input
- input
object
Output
- output CopyDBParameterGroupResult
CopyDBSnapshot
amazonaws_rds.CopyDBSnapshot({
"SourceDBSnapshotIdentifier": "",
"TargetDBSnapshotIdentifier": ""
}, context)
Input
- input
object
Output
- output CopyDBSnapshotResult
CopyOptionGroup
amazonaws_rds.CopyOptionGroup({
"SourceOptionGroupIdentifier": "",
"TargetOptionGroupIdentifier": "",
"TargetOptionGroupDescription": ""
}, context)
Input
- input
object
Output
- output CopyOptionGroupResult
CreateDBCluster
amazonaws_rds.CreateDBCluster({
"DBClusterIdentifier": "",
"Engine": ""
}, context)
Input
- input
object
- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- MasterUserPassword String
- MasterUsername String
- OptionGroupName String
- Port IntegerOptional
- PreSignedUrl String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- ReplicationSourceIdentifier String
- SourceRegion String
- StorageEncrypted BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output CreateDBClusterResult
CreateDBClusterParameterGroup
amazonaws_rds.CreateDBClusterParameterGroup({
"DBClusterParameterGroupName": "",
"DBParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
CreateDBClusterSnapshot
amazonaws_rds.CreateDBClusterSnapshot({
"DBClusterSnapshotIdentifier": "",
"DBClusterIdentifier": ""
}, context)
Input
- input
object
Output
CreateDBInstance
amazonaws_rds.CreateDBInstance({
"DBInstanceIdentifier": "",
"DBInstanceClass": "",
"Engine": ""
}, context)
Input
- input
object
- AllocatedStorage IntegerOptional
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- CopyTagsToSnapshot BooleanOptional
- DBClusterIdentifier String
- DBInstanceClass required String
- DBInstanceIdentifier required String
- DBName String
- DBParameterGroupName String
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Engine required String
- EngineVersion String
- Iops IntegerOptional
- KmsKeyId String
- LicenseModel String
- MasterUserPassword String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageEncrypted BooleanOptional
- StorageType String
- Tags TagList
- TdeCredentialArn String
- TdeCredentialPassword String
- Timezone String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output CreateDBInstanceResult
CreateDBInstanceReadReplica
amazonaws_rds.CreateDBInstanceReadReplica({
"DBInstanceIdentifier": "",
"SourceDBInstanceIdentifier": ""
}, context)
Input
- input
object
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBInstanceIdentifier required String
- DBSubnetGroupName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Iops IntegerOptional
- KmsKeyId String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreSignedUrl String
- PubliclyAccessible BooleanOptional
- SourceDBInstanceIdentifier required String
- SourceRegion String
- StorageType String
- Tags TagList
Output
CreateDBParameterGroup
amazonaws_rds.CreateDBParameterGroup({
"DBParameterGroupName": "",
"DBParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
- output CreateDBParameterGroupResult
CreateDBSecurityGroup
amazonaws_rds.CreateDBSecurityGroup({
"DBSecurityGroupName": "",
"DBSecurityGroupDescription": ""
}, context)
Input
- input
object
Output
- output CreateDBSecurityGroupResult
CreateDBSnapshot
amazonaws_rds.CreateDBSnapshot({
"DBSnapshotIdentifier": "",
"DBInstanceIdentifier": ""
}, context)
Input
Output
- output CreateDBSnapshotResult
CreateDBSubnetGroup
amazonaws_rds.CreateDBSubnetGroup({
"DBSubnetGroupName": "",
"DBSubnetGroupDescription": "",
"SubnetIds": []
}, context)
Input
- input
object
- DBSubnetGroupDescription required String
- DBSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
- Tags TagList
Output
- output CreateDBSubnetGroupResult
CreateEventSubscription
amazonaws_rds.CreateEventSubscription({
"SubscriptionName": "",
"SnsTopicArn": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- SnsTopicArn required String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
- Tags TagList
Output
CreateOptionGroup
amazonaws_rds.CreateOptionGroup({
"OptionGroupName": "",
"EngineName": "",
"MajorEngineVersion": "",
"OptionGroupDescription": ""
}, context)
Input
- input
object
Output
- output CreateOptionGroupResult
DeleteDBCluster
amazonaws_rds.DeleteDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
Output
- output DeleteDBClusterResult
DeleteDBClusterParameterGroup
amazonaws_rds.DeleteDBClusterParameterGroup({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
Output
Output schema unknown
DeleteDBClusterSnapshot
amazonaws_rds.DeleteDBClusterSnapshot({
"DBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBClusterSnapshotIdentifier required String
Output
DeleteDBInstance
amazonaws_rds.DeleteDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
Output
- output DeleteDBInstanceResult
DeleteDBParameterGroup
amazonaws_rds.DeleteDBParameterGroup({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- DBParameterGroupName required String
Output
Output schema unknown
DeleteDBSecurityGroup
amazonaws_rds.DeleteDBSecurityGroup({
"DBSecurityGroupName": ""
}, context)
Input
- input
object
- DBSecurityGroupName required String
Output
Output schema unknown
DeleteDBSnapshot
amazonaws_rds.DeleteDBSnapshot({
"DBSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBSnapshotIdentifier required String
Output
- output DeleteDBSnapshotResult
DeleteDBSubnetGroup
amazonaws_rds.DeleteDBSubnetGroup({
"DBSubnetGroupName": ""
}, context)
Input
- input
object
- DBSubnetGroupName required String
Output
Output schema unknown
DeleteEventSubscription
amazonaws_rds.DeleteEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- SubscriptionName required String
Output
DeleteOptionGroup
amazonaws_rds.DeleteOptionGroup({
"OptionGroupName": ""
}, context)
Input
- input
object
- OptionGroupName required String
Output
Output schema unknown
DescribeAccountAttributes
amazonaws_rds.DescribeAccountAttributes({}, context)
Input
- input
object
Output
- output AccountAttributesMessage
DescribeCertificates
amazonaws_rds.DescribeCertificates({}, context)
Input
- input
object
- CertificateIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
- output CertificateMessage
DescribeDBClusterParameterGroups
amazonaws_rds.DescribeDBClusterParameterGroups({}, context)
Input
- input
object
- DBClusterParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
DescribeDBClusterParameters
amazonaws_rds.DescribeDBClusterParameters({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
Output
DescribeDBClusterSnapshotAttributes
amazonaws_rds.DescribeDBClusterSnapshotAttributes({
"DBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBClusterSnapshotIdentifier required String
Output
DescribeDBClusterSnapshots
amazonaws_rds.DescribeDBClusterSnapshots({}, context)
Input
- input
object
- DBClusterIdentifier String
- DBClusterSnapshotIdentifier String
- Filters FilterList
- IncludePublic Boolean
- IncludeShared Boolean
- Marker String
- MaxRecords IntegerOptional
- SnapshotType String
Output
- output DBClusterSnapshotMessage
DescribeDBClusters
amazonaws_rds.DescribeDBClusters({}, context)
Input
- input
object
- DBClusterIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
- output DBClusterMessage
DescribeDBEngineVersions
amazonaws_rds.DescribeDBEngineVersions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupFamily String
- DefaultOnly Boolean
- Engine String
- EngineVersion String
- Filters FilterList
- ListSupportedCharacterSets BooleanOptional
- ListSupportedTimezones BooleanOptional
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBEngineVersionMessage
DescribeDBInstances
amazonaws_rds.DescribeDBInstances({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBInstanceMessage
DescribeDBLogFiles
amazonaws_rds.DescribeDBLogFiles({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceIdentifier required String
- FileLastWritten Long
- FileSize Long
- FilenameContains String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DescribeDBLogFilesResponse
DescribeDBParameterGroups
amazonaws_rds.DescribeDBParameterGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBParameterGroupsMessage
DescribeDBParameters
amazonaws_rds.DescribeDBParameters({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
- MaxRecords
Output
- output DBParameterGroupDetails
DescribeDBSecurityGroups
amazonaws_rds.DescribeDBSecurityGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBSecurityGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBSecurityGroupMessage
DescribeDBSnapshotAttributes
amazonaws_rds.DescribeDBSnapshotAttributes({
"DBSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBSnapshotIdentifier required String
Output
DescribeDBSnapshots
amazonaws_rds.DescribeDBSnapshots({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceIdentifier String
- DBSnapshotIdentifier String
- Filters FilterList
- IncludePublic Boolean
- IncludeShared Boolean
- Marker String
- MaxRecords IntegerOptional
- SnapshotType String
- MaxRecords
Output
- output DBSnapshotMessage
DescribeDBSubnetGroups
amazonaws_rds.DescribeDBSubnetGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBSubnetGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBSubnetGroupMessage
DescribeEngineDefaultClusterParameters
amazonaws_rds.DescribeEngineDefaultClusterParameters({
"DBParameterGroupFamily": ""
}, context)
Input
- input
object
- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
DescribeEngineDefaultParameters
amazonaws_rds.DescribeEngineDefaultParameters({
"DBParameterGroupFamily": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
DescribeEventCategories
amazonaws_rds.DescribeEventCategories({}, context)
Input
- input
object
- Filters FilterList
- SourceType String
Output
- output EventCategoriesMessage
DescribeEventSubscriptions
amazonaws_rds.DescribeEventSubscriptions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SubscriptionName String
- MaxRecords
Output
- output EventSubscriptionsMessage
DescribeEvents
amazonaws_rds.DescribeEvents({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Duration IntegerOptional
- EndTime TStamp
- EventCategories EventCategoriesList
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
- MaxRecords
Output
- output EventsMessage
DescribeOptionGroupOptions
amazonaws_rds.DescribeOptionGroupOptions({
"EngineName": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- EngineName required String
- Filters FilterList
- MajorEngineVersion String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output OptionGroupOptionsMessage
DescribeOptionGroups
amazonaws_rds.DescribeOptionGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- EngineName String
- Filters FilterList
- MajorEngineVersion String
- Marker String
- MaxRecords IntegerOptional
- OptionGroupName String
- MaxRecords
Output
- output OptionGroups
DescribeOrderableDBInstanceOptions
amazonaws_rds.DescribeOrderableDBInstanceOptions({
"Engine": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceClass String
- Engine required String
- EngineVersion String
- Filters FilterList
- LicenseModel String
- Marker String
- MaxRecords IntegerOptional
- Vpc BooleanOptional
- MaxRecords
Output
DescribePendingMaintenanceActions
amazonaws_rds.DescribePendingMaintenanceActions({}, context)
Input
- input
object
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- ResourceIdentifier String
Output
DescribeReservedDBInstances
amazonaws_rds.DescribeReservedDBInstances({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceClass String
- Duration String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MultiAZ BooleanOptional
- OfferingType String
- ProductDescription String
- ReservedDBInstanceId String
- ReservedDBInstancesOfferingId String
- MaxRecords
Output
- output ReservedDBInstanceMessage
DescribeReservedDBInstancesOfferings
amazonaws_rds.DescribeReservedDBInstancesOfferings({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceClass String
- Duration String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MultiAZ BooleanOptional
- OfferingType String
- ProductDescription String
- ReservedDBInstancesOfferingId String
- MaxRecords
Output
DescribeSourceRegions
amazonaws_rds.DescribeSourceRegions({}, context)
Input
- input
object
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- RegionName String
Output
- output SourceRegionMessage
DescribeValidDBInstanceModifications
amazonaws_rds.DescribeValidDBInstanceModifications({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- DBInstanceIdentifier required String
Output
DownloadDBLogFilePortion
amazonaws_rds.DownloadDBLogFilePortion({
"DBInstanceIdentifier": "",
"LogFileName": ""
}, context)
Input
- input
object
Output
FailoverDBCluster
amazonaws_rds.FailoverDBCluster({}, context)
Input
Output
- output FailoverDBClusterResult
ListTagsForResource
amazonaws_rds.ListTagsForResource({
"ResourceName": ""
}, context)
Input
- input
object
- Filters FilterList
- ResourceName required String
Output
- output TagListMessage
ModifyDBCluster
amazonaws_rds.ModifyDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
- ApplyImmediately Boolean
- BackupRetentionPeriod IntegerOptional
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- EnableIAMDatabaseAuthentication BooleanOptional
- MasterUserPassword String
- NewDBClusterIdentifier String
- OptionGroupName String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output ModifyDBClusterResult
ModifyDBClusterParameterGroup
amazonaws_rds.ModifyDBClusterParameterGroup({
"DBClusterParameterGroupName": "",
"Parameters": []
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Parameters required ParametersList
Output
ModifyDBClusterSnapshotAttribute
amazonaws_rds.ModifyDBClusterSnapshotAttribute({
"DBClusterSnapshotIdentifier": "",
"AttributeName": ""
}, context)
Input
- input
object
- AttributeName required String
- DBClusterSnapshotIdentifier required String
- ValuesToAdd AttributeValueList
- ValuesToRemove AttributeValueList
Output
ModifyDBInstance
amazonaws_rds.ModifyDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- AllocatedStorage IntegerOptional
- AllowMajorVersionUpgrade Boolean
- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- BackupRetentionPeriod IntegerOptional
- CACertificateIdentifier String
- CloudwatchLogsExportConfiguration CloudwatchLogsExportConfiguration
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBInstanceIdentifier required String
- DBParameterGroupName String
- DBPortNumber IntegerOptional
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- EngineVersion String
- Iops IntegerOptional
- LicenseModel String
- MasterUserPassword String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- NewDBInstanceIdentifier String
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageType String
- TdeCredentialArn String
- TdeCredentialPassword String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output ModifyDBInstanceResult
ModifyDBParameterGroup
amazonaws_rds.ModifyDBParameterGroup({
"DBParameterGroupName": "",
"Parameters": []
}, context)
Input
- input
object
- DBParameterGroupName required String
- Parameters required ParametersList
Output
- output DBParameterGroupNameMessage
ModifyDBSnapshot
amazonaws_rds.ModifyDBSnapshot({
"DBSnapshotIdentifier": ""
}, context)
Input
Output
- output ModifyDBSnapshotResult
ModifyDBSnapshotAttribute
amazonaws_rds.ModifyDBSnapshotAttribute({
"DBSnapshotIdentifier": "",
"AttributeName": ""
}, context)
Input
- input
object
- AttributeName required String
- DBSnapshotIdentifier required String
- ValuesToAdd AttributeValueList
- ValuesToRemove AttributeValueList
Output
ModifyDBSubnetGroup
amazonaws_rds.ModifyDBSubnetGroup({
"DBSubnetGroupName": "",
"SubnetIds": []
}, context)
Input
- input
object
- DBSubnetGroupDescription String
- DBSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
Output
- output ModifyDBSubnetGroupResult
ModifyEventSubscription
amazonaws_rds.ModifyEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- SnsTopicArn String
- SourceType String
- SubscriptionName required String
Output
ModifyOptionGroup
amazonaws_rds.ModifyOptionGroup({
"OptionGroupName": ""
}, context)
Input
- input
object
- ApplyImmediately Boolean
- OptionGroupName required String
- OptionsToInclude OptionConfigurationList
- OptionsToRemove OptionNamesList
Output
- output ModifyOptionGroupResult
PromoteReadReplica
amazonaws_rds.PromoteReadReplica({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- BackupRetentionPeriod IntegerOptional
- DBInstanceIdentifier required String
- PreferredBackupWindow String
Output
- output PromoteReadReplicaResult
PromoteReadReplicaDBCluster
amazonaws_rds.PromoteReadReplicaDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
- DBClusterIdentifier required String
Output
PurchaseReservedDBInstancesOffering
amazonaws_rds.PurchaseReservedDBInstancesOffering({
"ReservedDBInstancesOfferingId": ""
}, context)
Input
- input
object
- DBInstanceCount IntegerOptional
- ReservedDBInstanceId String
- ReservedDBInstancesOfferingId required String
- Tags TagList
Output
RebootDBInstance
amazonaws_rds.RebootDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- DBInstanceIdentifier required String
- ForceFailover BooleanOptional
Output
- output RebootDBInstanceResult
RemoveRoleFromDBCluster
amazonaws_rds.RemoveRoleFromDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}, context)
Input
Output
Output schema unknown
RemoveSourceIdentifierFromSubscription
amazonaws_rds.RemoveSourceIdentifierFromSubscription({
"SubscriptionName": "",
"SourceIdentifier": ""
}, context)
Input
Output
RemoveTagsFromResource
amazonaws_rds.RemoveTagsFromResource({
"ResourceName": "",
"TagKeys": []
}, context)
Input
Output
Output schema unknown
ResetDBClusterParameterGroup
amazonaws_rds.ResetDBClusterParameterGroup({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Parameters ParametersList
- ResetAllParameters Boolean
Output
ResetDBParameterGroup
amazonaws_rds.ResetDBParameterGroup({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- DBParameterGroupName required String
- Parameters ParametersList
- ResetAllParameters Boolean
Output
- output DBParameterGroupNameMessage
RestoreDBClusterFromS3
amazonaws_rds.RestoreDBClusterFromS3({
"DBClusterIdentifier": "",
"Engine": "",
"MasterUsername": "",
"MasterUserPassword": "",
"SourceEngine": "",
"SourceEngineVersion": "",
"S3BucketName": "",
"S3IngestionRoleArn": ""
}, context)
Input
- input
object
- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- MasterUserPassword required String
- MasterUsername required String
- OptionGroupName String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- S3BucketName required String
- S3IngestionRoleArn required String
- S3Prefix String
- SourceEngine required String
- SourceEngineVersion required String
- StorageEncrypted BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output RestoreDBClusterFromS3Result
RestoreDBClusterFromSnapshot
amazonaws_rds.RestoreDBClusterFromSnapshot({
"DBClusterIdentifier": "",
"SnapshotIdentifier": "",
"Engine": ""
}, context)
Input
- input
object
- AvailabilityZones AvailabilityZones
- DBClusterIdentifier required String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- OptionGroupName String
- Port IntegerOptional
- SnapshotIdentifier required String
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
RestoreDBClusterToPointInTime
amazonaws_rds.RestoreDBClusterToPointInTime({
"DBClusterIdentifier": "",
"SourceDBClusterIdentifier": ""
}, context)
Input
- input
object
- DBClusterIdentifier required String
- DBSubnetGroupName String
- EnableIAMDatabaseAuthentication BooleanOptional
- KmsKeyId String
- OptionGroupName String
- Port IntegerOptional
- RestoreToTime TStamp
- RestoreType String
- SourceDBClusterIdentifier required String
- Tags TagList
- UseLatestRestorableTime Boolean
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
RestoreDBInstanceFromDBSnapshot
amazonaws_rds.RestoreDBInstanceFromDBSnapshot({
"DBInstanceIdentifier": "",
"DBSnapshotIdentifier": ""
}, context)
Input
- input
object
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBInstanceIdentifier required String
- DBName String
- DBSnapshotIdentifier required String
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine String
- Iops IntegerOptional
- LicenseModel String
- MultiAZ BooleanOptional
- OptionGroupName String
- Port IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageType String
- Tags TagList
- TdeCredentialArn String
- TdeCredentialPassword String
Output
RestoreDBInstanceFromS3
amazonaws_rds.RestoreDBInstanceFromS3({
"DBInstanceIdentifier": "",
"DBInstanceClass": "",
"Engine": "",
"SourceEngine": "",
"SourceEngineVersion": "",
"S3BucketName": "",
"S3IngestionRoleArn": ""
}, context)
Input
- input
object
- AllocatedStorage IntegerOptional
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- BackupRetentionPeriod IntegerOptional
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass required String
- DBInstanceIdentifier required String
- DBName String
- DBParameterGroupName String
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Engine required String
- EngineVersion String
- Iops IntegerOptional
- KmsKeyId String
- LicenseModel String
- MasterUserPassword String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PubliclyAccessible BooleanOptional
- S3BucketName required String
- S3IngestionRoleArn required String
- S3Prefix String
- SourceEngine required String
- SourceEngineVersion required String
- StorageEncrypted BooleanOptional
- StorageType String
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
RestoreDBInstanceToPointInTime
amazonaws_rds.RestoreDBInstanceToPointInTime({
"SourceDBInstanceIdentifier": "",
"TargetDBInstanceIdentifier": ""
}, context)
Input
- input
object
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBName String
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine String
- Iops IntegerOptional
- LicenseModel String
- MultiAZ BooleanOptional
- OptionGroupName String
- Port IntegerOptional
- PubliclyAccessible BooleanOptional
- RestoreTime TStamp
- SourceDBInstanceIdentifier required String
- StorageType String
- Tags TagList
- TargetDBInstanceIdentifier required String
- TdeCredentialArn String
- TdeCredentialPassword String
- UseLatestRestorableTime Boolean
Output
RevokeDBSecurityGroupIngress
amazonaws_rds.RevokeDBSecurityGroupIngress({
"DBSecurityGroupName": ""
}, context)
Input
- input
object
Output
StartDBInstance
amazonaws_rds.StartDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- DBInstanceIdentifier required String
Output
- output StartDBInstanceResult
StopDBInstance
amazonaws_rds.StopDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
Output
- output StopDBInstanceResult
Definitions
AccountAttributesMessage
- AccountAttributesMessage
object
: Data returned by the DescribeAccountAttributes action.- AccountQuotas AccountQuotaList
AccountQuota
- AccountQuota
object
: Describes a quota for an AWS account, for example, the number of DB instances allowed.
AccountQuotaList
- AccountQuotaList
array
- items AccountQuota
AddRoleToDBClusterMessage
AddSourceIdentifierToSubscriptionMessage
- AddSourceIdentifierToSubscriptionMessage
object
:
AddSourceIdentifierToSubscriptionResult
- AddSourceIdentifierToSubscriptionResult
object
- EventSubscription EventSubscription
AddTagsToResourceMessage
ApplyMethod
- ApplyMethod
string
(values: immediate, pending-reboot)
ApplyPendingMaintenanceActionMessage
- ApplyPendingMaintenanceActionMessage
object
:
ApplyPendingMaintenanceActionResult
- ApplyPendingMaintenanceActionResult
object
- ResourcePendingMaintenanceActions ResourcePendingMaintenanceActions
AttributeValueList
- AttributeValueList
array
- items String
AuthorizationAlreadyExistsFault
- AuthorizationAlreadyExistsFault
object
: The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
AuthorizationNotFoundFault
- AuthorizationNotFoundFault
object
: Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. RDS may not also be authorized via IAM to perform necessary actions on your behalf.
AuthorizationQuotaExceededFault
- AuthorizationQuotaExceededFault
object
: DB security group authorization quota has been reached.
AuthorizeDBSecurityGroupIngressMessage
- AuthorizeDBSecurityGroupIngressMessage
object
:
AuthorizeDBSecurityGroupIngressResult
- AuthorizeDBSecurityGroupIngressResult
object
- DBSecurityGroup DBSecurityGroup
AvailabilityZone
- AvailabilityZone
object
: Contains Availability Zone information. This data type is used as an element in the following data type: OrderableDBInstanceOption- Name String
AvailabilityZoneList
- AvailabilityZoneList
array
- items AvailabilityZone
AvailabilityZones
- AvailabilityZones
array
- items String
Boolean
- Boolean
boolean
BooleanOptional
- BooleanOptional
boolean
Certificate
- Certificate
object
: A CA certificate for an AWS account.
CertificateList
- CertificateList
array
- items Certificate
CertificateMessage
- CertificateMessage
object
: Data returned by the DescribeCertificates action.- Certificates CertificateList
- Marker String
CertificateNotFoundFault
- CertificateNotFoundFault
object
: CertificateIdentifier does not refer to an existing certificate.
CharacterSet
- CharacterSet
object
: This data type is used as a response element in the action DescribeDBEngineVersions.
CloudwatchLogsExportConfiguration
- CloudwatchLogsExportConfiguration
object
: The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.- DisableLogTypes LogTypeList
- EnableLogTypes LogTypeList
CopyDBClusterParameterGroupMessage
- CopyDBClusterParameterGroupMessage
object
CopyDBClusterParameterGroupResult
- CopyDBClusterParameterGroupResult
object
- DBClusterParameterGroup DBClusterParameterGroup
CopyDBClusterSnapshotMessage
- CopyDBClusterSnapshotMessage
object
:
CopyDBClusterSnapshotResult
- CopyDBClusterSnapshotResult
object
- DBClusterSnapshot DBClusterSnapshot
CopyDBParameterGroupMessage
- CopyDBParameterGroupMessage
object
:
CopyDBParameterGroupResult
- CopyDBParameterGroupResult
object
- DBParameterGroup DBParameterGroup
CopyDBSnapshotMessage
- CopyDBSnapshotMessage
object
:
CopyDBSnapshotResult
- CopyDBSnapshotResult
object
- DBSnapshot DBSnapshot
CopyOptionGroupMessage
- CopyOptionGroupMessage
object
:
CopyOptionGroupResult
- CopyOptionGroupResult
object
- OptionGroup OptionGroup
CreateDBClusterMessage
- CreateDBClusterMessage
object
:- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- MasterUserPassword String
- MasterUsername String
- OptionGroupName String
- Port IntegerOptional
- PreSignedUrl String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- ReplicationSourceIdentifier String
- SourceRegion String
- StorageEncrypted BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
CreateDBClusterParameterGroupMessage
- CreateDBClusterParameterGroupMessage
object
:
CreateDBClusterParameterGroupResult
- CreateDBClusterParameterGroupResult
object
- DBClusterParameterGroup DBClusterParameterGroup
CreateDBClusterResult
- CreateDBClusterResult
object
- DBCluster DBCluster
CreateDBClusterSnapshotMessage
- CreateDBClusterSnapshotMessage
object
:
CreateDBClusterSnapshotResult
- CreateDBClusterSnapshotResult
object
- DBClusterSnapshot DBClusterSnapshot
CreateDBInstanceMessage
- CreateDBInstanceMessage
object
:- AllocatedStorage IntegerOptional
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- CopyTagsToSnapshot BooleanOptional
- DBClusterIdentifier String
- DBInstanceClass required String
- DBInstanceIdentifier required String
- DBName String
- DBParameterGroupName String
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Engine required String
- EngineVersion String
- Iops IntegerOptional
- KmsKeyId String
- LicenseModel String
- MasterUserPassword String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageEncrypted BooleanOptional
- StorageType String
- Tags TagList
- TdeCredentialArn String
- TdeCredentialPassword String
- Timezone String
- VpcSecurityGroupIds VpcSecurityGroupIdList
CreateDBInstanceReadReplicaMessage
- CreateDBInstanceReadReplicaMessage
object
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBInstanceIdentifier required String
- DBSubnetGroupName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Iops IntegerOptional
- KmsKeyId String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreSignedUrl String
- PubliclyAccessible BooleanOptional
- SourceDBInstanceIdentifier required String
- SourceRegion String
- StorageType String
- Tags TagList
CreateDBInstanceReadReplicaResult
- CreateDBInstanceReadReplicaResult
object
- DBInstance DBInstance
CreateDBInstanceResult
- CreateDBInstanceResult
object
- DBInstance DBInstance
CreateDBParameterGroupMessage
- CreateDBParameterGroupMessage
object
:
CreateDBParameterGroupResult
- CreateDBParameterGroupResult
object
- DBParameterGroup DBParameterGroup
CreateDBSecurityGroupMessage
- CreateDBSecurityGroupMessage
object
:- DBSecurityGroupDescription required [String](#