npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_docdb

v5.0.0

Published

DataFire integration for Amazon DocumentDB with MongoDB compatibility

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_docdb

Client library for Amazon DocumentDB with MongoDB compatibility

Installation and Usage

npm install --save @datafire/amazonaws_docdb
let amazonaws_docdb = require('@datafire/amazonaws_docdb').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon DocumentDB API documentation

Actions

AddTagsToResource

amazonaws_docdb.AddTagsToResource({
  "ResourceName": "",
  "Tags": []
}, context)

Input

  • input object
    • ResourceName required string
    • Tags required array

Output

Output schema unknown

AddTagsToResource

amazonaws_docdb.AddTagsToResource({
  "ResourceName": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceName required
    • Tags required
      • items
        • Key
        • Value

Output

Output schema unknown

ApplyPendingMaintenanceAction

amazonaws_docdb.ApplyPendingMaintenanceAction({
  "ResourceIdentifier": "",
  "ApplyAction": "",
  "OptInType": ""
}, context)

Input

  • input object
    • ResourceIdentifier required string
    • ApplyAction required string
    • OptInType required string

Output

ApplyPendingMaintenanceAction

amazonaws_docdb.ApplyPendingMaintenanceAction({
  "ResourceIdentifier": null,
  "ApplyAction": null,
  "OptInType": null
}, context)

Input

  • input object
    • ApplyAction required
    • OptInType required
    • ResourceIdentifier required

Output

CopyDBClusterParameterGroup

amazonaws_docdb.CopyDBClusterParameterGroup({
  "SourceDBClusterParameterGroupIdentifier": "",
  "TargetDBClusterParameterGroupIdentifier": "",
  "TargetDBClusterParameterGroupDescription": ""
}, context)

Input

  • input object
    • SourceDBClusterParameterGroupIdentifier required string
    • TargetDBClusterParameterGroupIdentifier required string
    • TargetDBClusterParameterGroupDescription required string
    • Tags array

Output

CopyDBClusterParameterGroup

amazonaws_docdb.CopyDBClusterParameterGroup({
  "SourceDBClusterParameterGroupIdentifier": null,
  "TargetDBClusterParameterGroupIdentifier": null,
  "TargetDBClusterParameterGroupDescription": null
}, context)

Input

  • input object
    • SourceDBClusterParameterGroupIdentifier required
    • Tags
      • items
        • Key
        • Value
    • TargetDBClusterParameterGroupDescription required
    • TargetDBClusterParameterGroupIdentifier required

Output

CopyDBClusterSnapshot

amazonaws_docdb.CopyDBClusterSnapshot({
  "SourceDBClusterSnapshotIdentifier": "",
  "TargetDBClusterSnapshotIdentifier": ""
}, context)

Input

  • input object
    • SourceDBClusterSnapshotIdentifier required string
    • TargetDBClusterSnapshotIdentifier required string
    • KmsKeyId string
    • PreSignedUrl string
    • CopyTags boolean
    • Tags array

Output

CopyDBClusterSnapshot

amazonaws_docdb.CopyDBClusterSnapshot({
  "SourceDBClusterSnapshotIdentifier": null,
  "TargetDBClusterSnapshotIdentifier": null
}, context)

Input

  • input object
    • CopyTags
    • KmsKeyId
    • PreSignedUrl
    • SourceDBClusterSnapshotIdentifier required
    • Tags
      • items
        • Key
        • Value
    • TargetDBClusterSnapshotIdentifier required

Output

CreateDBCluster

amazonaws_docdb.CreateDBCluster({
  "DBClusterIdentifier": "",
  "Engine": "",
  "MasterUsername": "",
  "MasterUserPassword": ""
}, context)

Input

  • input object
    • AvailabilityZones array
    • BackupRetentionPeriod integer
    • DBClusterIdentifier required string
    • DBClusterParameterGroupName string
    • VpcSecurityGroupIds array
    • DBSubnetGroupName string
    • Engine required string
    • EngineVersion string
    • Port integer
    • MasterUsername required string
    • MasterUserPassword required string
    • PreferredBackupWindow string
    • PreferredMaintenanceWindow string
    • Tags array
    • StorageEncrypted boolean
    • KmsKeyId string
    • PreSignedUrl string
    • EnableCloudwatchLogsExports array
    • DeletionProtection boolean

Output

CreateDBCluster

amazonaws_docdb.CreateDBCluster({
  "DBClusterIdentifier": null,
  "Engine": null,
  "MasterUsername": null,
  "MasterUserPassword": null
}, context)

Input

  • input object
    • AvailabilityZones
      • items
    • BackupRetentionPeriod
    • DBClusterIdentifier required
    • DBClusterParameterGroupName
    • DBSubnetGroupName
    • DeletionProtection
    • EnableCloudwatchLogsExports
    • Engine required
    • EngineVersion
    • KmsKeyId
    • MasterUserPassword required
    • MasterUsername required
    • Port
    • PreSignedUrl
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • StorageEncrypted
    • Tags
      • items
        • Key
        • Value
    • VpcSecurityGroupIds
      • items

Output

CreateDBClusterParameterGroup

amazonaws_docdb.CreateDBClusterParameterGroup({
  "DBClusterParameterGroupName": "",
  "DBParameterGroupFamily": "",
  "Description": ""
}, context)

Input

  • input object
    • DBClusterParameterGroupName required string
    • DBParameterGroupFamily required string
    • Description required string
    • Tags array

Output

CreateDBClusterParameterGroup

amazonaws_docdb.CreateDBClusterParameterGroup({
  "DBClusterParameterGroupName": null,
  "DBParameterGroupFamily": null,
  "Description": null
}, context)

Input

  • input object
    • DBClusterParameterGroupName required
    • DBParameterGroupFamily required
    • Description required
    • Tags
      • items
        • Key
        • Value

Output

CreateDBClusterSnapshot

amazonaws_docdb.CreateDBClusterSnapshot({
  "DBClusterSnapshotIdentifier": "",
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required string
    • DBClusterIdentifier required string
    • Tags array

Output

CreateDBClusterSnapshot

amazonaws_docdb.CreateDBClusterSnapshot({
  "DBClusterSnapshotIdentifier": null,
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • DBClusterIdentifier required
    • DBClusterSnapshotIdentifier required
    • Tags
      • items
        • Key
        • Value

Output

CreateDBInstance

amazonaws_docdb.CreateDBInstance({
  "DBInstanceIdentifier": "",
  "DBInstanceClass": "",
  "Engine": "",
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBInstanceIdentifier required string
    • DBInstanceClass required string
    • Engine required string
    • AvailabilityZone string
    • PreferredMaintenanceWindow string
    • AutoMinorVersionUpgrade boolean
    • Tags array
    • DBClusterIdentifier required string
    • PromotionTier integer

Output

CreateDBInstance

amazonaws_docdb.CreateDBInstance({
  "DBInstanceIdentifier": null,
  "DBInstanceClass": null,
  "Engine": null,
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DBClusterIdentifier required
    • DBInstanceClass required
    • DBInstanceIdentifier required
    • Engine required
    • PreferredMaintenanceWindow
    • PromotionTier
    • Tags
      • items
        • Key
        • Value

Output

CreateDBSubnetGroup

amazonaws_docdb.CreateDBSubnetGroup({
  "DBSubnetGroupName": "",
  "DBSubnetGroupDescription": "",
  "SubnetIds": []
}, context)

Input

  • input object
    • DBSubnetGroupName required string
    • DBSubnetGroupDescription required string
    • SubnetIds required array
    • Tags array

Output

CreateDBSubnetGroup

amazonaws_docdb.CreateDBSubnetGroup({
  "DBSubnetGroupName": null,
  "DBSubnetGroupDescription": null,
  "SubnetIds": null
}, context)

Input

  • input object
    • DBSubnetGroupDescription required
    • DBSubnetGroupName required
    • SubnetIds required
      • items
    • Tags
      • items
        • Key
        • Value

Output

DeleteDBCluster

amazonaws_docdb.DeleteDBCluster({
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterIdentifier required string
    • SkipFinalSnapshot boolean
    • FinalDBSnapshotIdentifier string

Output

DeleteDBCluster

amazonaws_docdb.DeleteDBCluster({
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • DBClusterIdentifier required
    • FinalDBSnapshotIdentifier
    • SkipFinalSnapshot

Output

DeleteDBClusterParameterGroup

amazonaws_docdb.DeleteDBClusterParameterGroup({
  "DBClusterParameterGroupName": ""
}, context)

Input

  • input object
    • DBClusterParameterGroupName required string

Output

Output schema unknown

DeleteDBClusterParameterGroup

amazonaws_docdb.DeleteDBClusterParameterGroup({
  "DBClusterParameterGroupName": null
}, context)

Input

  • input object
    • DBClusterParameterGroupName required

Output

Output schema unknown

DeleteDBClusterSnapshot

amazonaws_docdb.DeleteDBClusterSnapshot({
  "DBClusterSnapshotIdentifier": ""
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required string

Output

DeleteDBClusterSnapshot

amazonaws_docdb.DeleteDBClusterSnapshot({
  "DBClusterSnapshotIdentifier": null
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required

Output

DeleteDBInstance

amazonaws_docdb.DeleteDBInstance({
  "DBInstanceIdentifier": ""
}, context)

Input

  • input object
    • DBInstanceIdentifier required string

Output

DeleteDBInstance

amazonaws_docdb.DeleteDBInstance({
  "DBInstanceIdentifier": null
}, context)

Input

  • input object
    • DBInstanceIdentifier required

Output

DeleteDBSubnetGroup

amazonaws_docdb.DeleteDBSubnetGroup({
  "DBSubnetGroupName": ""
}, context)

Input

  • input object
    • DBSubnetGroupName required string

Output

Output schema unknown

DeleteDBSubnetGroup

amazonaws_docdb.DeleteDBSubnetGroup({
  "DBSubnetGroupName": null
}, context)

Input

  • input object
    • DBSubnetGroupName required

Output

Output schema unknown

DescribeCertificates

amazonaws_docdb.DescribeCertificates({}, context)

Input

  • input object
    • CertificateIdentifier string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeCertificates

amazonaws_docdb.DescribeCertificates({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • CertificateIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeDBClusterParameterGroups

amazonaws_docdb.DescribeDBClusterParameterGroups({}, context)

Input

  • input object
    • DBClusterParameterGroupName string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeDBClusterParameterGroups

amazonaws_docdb.DescribeDBClusterParameterGroups({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBClusterParameterGroupName
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeDBClusterParameters

amazonaws_docdb.DescribeDBClusterParameters({
  "DBClusterParameterGroupName": ""
}, context)

Input

  • input object
    • DBClusterParameterGroupName required string
    • Source string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeDBClusterParameters

amazonaws_docdb.DescribeDBClusterParameters({
  "DBClusterParameterGroupName": null
}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBClusterParameterGroupName required
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • Source

Output

DescribeDBClusterSnapshotAttributes

amazonaws_docdb.DescribeDBClusterSnapshotAttributes({
  "DBClusterSnapshotIdentifier": ""
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required string

Output

DescribeDBClusterSnapshotAttributes

amazonaws_docdb.DescribeDBClusterSnapshotAttributes({
  "DBClusterSnapshotIdentifier": null
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required

Output

DescribeDBClusterSnapshots

amazonaws_docdb.DescribeDBClusterSnapshots({}, context)

Input

  • input object
    • DBClusterIdentifier string
    • DBClusterSnapshotIdentifier string
    • SnapshotType string
    • Filters array
    • MaxRecords integer
    • Marker string
    • IncludeShared boolean
    • IncludePublic boolean

Output

DescribeDBClusterSnapshots

amazonaws_docdb.DescribeDBClusterSnapshots({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBClusterIdentifier
    • DBClusterSnapshotIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • IncludePublic
    • IncludeShared
    • Marker
    • MaxRecords
    • SnapshotType

Output

DescribeDBClusters

amazonaws_docdb.DescribeDBClusters({}, context)

Input

  • input object
    • DBClusterIdentifier string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeDBClusters

amazonaws_docdb.DescribeDBClusters({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBClusterIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeDBEngineVersions

amazonaws_docdb.DescribeDBEngineVersions({}, context)

Input

  • input object
    • Engine string
    • EngineVersion string
    • DBParameterGroupFamily string
    • Filters array
    • MaxRecords integer
    • Marker string
    • DefaultOnly boolean
    • ListSupportedCharacterSets boolean
    • ListSupportedTimezones boolean

Output

DescribeDBEngineVersions

amazonaws_docdb.DescribeDBEngineVersions({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBParameterGroupFamily
    • DefaultOnly
    • Engine
    • EngineVersion
    • Filters
      • items
        • Name required
        • Values required
          • items
    • ListSupportedCharacterSets
    • ListSupportedTimezones
    • Marker
    • MaxRecords

Output

DescribeDBInstances

amazonaws_docdb.DescribeDBInstances({}, context)

Input

  • input object
    • DBInstanceIdentifier string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeDBInstances

amazonaws_docdb.DescribeDBInstances({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBInstanceIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeDBSubnetGroups

amazonaws_docdb.DescribeDBSubnetGroups({}, context)

Input

  • input object
    • DBSubnetGroupName string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeDBSubnetGroups

amazonaws_docdb.DescribeDBSubnetGroups({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBSubnetGroupName
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeEngineDefaultClusterParameters

amazonaws_docdb.DescribeEngineDefaultClusterParameters({
  "DBParameterGroupFamily": ""
}, context)

Input

  • input object
    • DBParameterGroupFamily required string
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeEngineDefaultClusterParameters

amazonaws_docdb.DescribeEngineDefaultClusterParameters({
  "DBParameterGroupFamily": null
}, context)

Input

  • input object
    • DBParameterGroupFamily required
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

Output

DescribeEventCategories

amazonaws_docdb.DescribeEventCategories({}, context)

Input

  • input object
    • SourceType string
    • Filters array

Output

DescribeEventCategories

amazonaws_docdb.DescribeEventCategories({}, context)

Input

  • input object
    • Filters
      • items
        • Name required
        • Values required
          • items
    • SourceType

Output

DescribeEvents

amazonaws_docdb.DescribeEvents({}, context)

Input

  • input object
    • SourceIdentifier string
    • SourceType string
    • StartTime string
    • EndTime string
    • Duration integer
    • EventCategories array
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeEvents

amazonaws_docdb.DescribeEvents({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • Duration
    • EndTime
    • EventCategories
      • items
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • SourceIdentifier
    • SourceType
    • StartTime

Output

DescribeOrderableDBInstanceOptions

amazonaws_docdb.DescribeOrderableDBInstanceOptions({
  "Engine": ""
}, context)

Input

  • input object
    • Engine required string
    • EngineVersion string
    • DBInstanceClass string
    • LicenseModel string
    • Vpc boolean
    • Filters array
    • MaxRecords integer
    • Marker string

Output

DescribeOrderableDBInstanceOptions

amazonaws_docdb.DescribeOrderableDBInstanceOptions({
  "Engine": null
}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • DBInstanceClass
    • Engine required
    • EngineVersion
    • Filters
      • items
        • Name required
        • Values required
          • items
    • LicenseModel
    • Marker
    • MaxRecords
    • Vpc

Output

DescribePendingMaintenanceActions

amazonaws_docdb.DescribePendingMaintenanceActions({}, context)

Input

  • input object
    • ResourceIdentifier string
    • Filters array
    • Marker string
    • MaxRecords integer

Output

DescribePendingMaintenanceActions

amazonaws_docdb.DescribePendingMaintenanceActions({}, context)

Input

  • input object
    • MaxRecords string
    • Marker string
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • ResourceIdentifier

Output

FailoverDBCluster

amazonaws_docdb.FailoverDBCluster({}, context)

Input

  • input object
    • DBClusterIdentifier string
    • TargetDBInstanceIdentifier string

Output

FailoverDBCluster

amazonaws_docdb.FailoverDBCluster({}, context)

Input

  • input object
    • DBClusterIdentifier
    • TargetDBInstanceIdentifier

Output

ListTagsForResource

amazonaws_docdb.ListTagsForResource({
  "ResourceName": ""
}, context)

Input

  • input object
    • ResourceName required string
    • Filters array

Output

ListTagsForResource

amazonaws_docdb.ListTagsForResource({
  "ResourceName": null
}, context)

Input

  • input object
    • Filters
      • items
        • Name required
        • Values required
          • items
    • ResourceName required

Output

ModifyDBCluster

amazonaws_docdb.ModifyDBCluster({
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterIdentifier required string
    • NewDBClusterIdentifier string
    • ApplyImmediately boolean
    • BackupRetentionPeriod integer
    • DBClusterParameterGroupName string
    • VpcSecurityGroupIds array
    • Port integer
    • MasterUserPassword string
    • PreferredBackupWindow string
    • PreferredMaintenanceWindow string
    • CloudwatchLogsExportConfiguration object
    • EngineVersion string
    • DeletionProtection boolean

Output

ModifyDBCluster

amazonaws_docdb.ModifyDBCluster({
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • ApplyImmediately
    • BackupRetentionPeriod
    • CloudwatchLogsExportConfiguration
    • DBClusterIdentifier required
    • DBClusterParameterGroupName
    • DeletionProtection
    • EngineVersion
    • MasterUserPassword
    • NewDBClusterIdentifier
    • Port
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • VpcSecurityGroupIds
      • items

Output

ModifyDBClusterParameterGroup

amazonaws_docdb.ModifyDBClusterParameterGroup({
  "DBClusterParameterGroupName": "",
  "Parameters": []
}, context)

Input

  • input object
    • DBClusterParameterGroupName required string
    • Parameters required array

Output

ModifyDBClusterParameterGroup

amazonaws_docdb.ModifyDBClusterParameterGroup({
  "DBClusterParameterGroupName": null,
  "Parameters": null
}, context)

Input

  • input object
    • DBClusterParameterGroupName required
    • Parameters required
      • items
        • AllowedValues
        • ApplyMethod
        • ApplyType
        • DataType
        • Description
        • IsModifiable
        • MinimumEngineVersion
        • ParameterName
        • ParameterValue
        • Source

Output

ModifyDBClusterSnapshotAttribute

amazonaws_docdb.ModifyDBClusterSnapshotAttribute({
  "DBClusterSnapshotIdentifier": "",
  "AttributeName": ""
}, context)

Input

  • input object
    • DBClusterSnapshotIdentifier required string
    • AttributeName required string
    • ValuesToAdd array
    • ValuesToRemove array

Output

ModifyDBClusterSnapshotAttribute

amazonaws_docdb.ModifyDBClusterSnapshotAttribute({
  "DBClusterSnapshotIdentifier": null,
  "AttributeName": null
}, context)

Input

  • input object
    • AttributeName required
    • DBClusterSnapshotIdentifier required
    • ValuesToAdd
      • items
    • ValuesToRemove
      • items

Output

ModifyDBInstance

amazonaws_docdb.ModifyDBInstance({
  "DBInstanceIdentifier": ""
}, context)

Input

  • input object
    • DBInstanceIdentifier required string
    • DBInstanceClass string
    • ApplyImmediately boolean
    • PreferredMaintenanceWindow string
    • AutoMinorVersionUpgrade boolean
    • NewDBInstanceIdentifier string
    • CACertificateIdentifier string
    • PromotionTier integer

Output

ModifyDBInstance

amazonaws_docdb.ModifyDBInstance({
  "DBInstanceIdentifier": null
}, context)

Input

  • input object
    • ApplyImmediately
    • AutoMinorVersionUpgrade
    • CACertificateIdentifier
    • DBInstanceClass
    • DBInstanceIdentifier required
    • NewDBInstanceIdentifier
    • PreferredMaintenanceWindow
    • PromotionTier

Output

ModifyDBSubnetGroup

amazonaws_docdb.ModifyDBSubnetGroup({
  "DBSubnetGroupName": "",
  "SubnetIds": []
}, context)

Input

  • input object
    • DBSubnetGroupName required string
    • DBSubnetGroupDescription string
    • SubnetIds required array

Output

ModifyDBSubnetGroup

amazonaws_docdb.ModifyDBSubnetGroup({
  "DBSubnetGroupName": null,
  "SubnetIds": null
}, context)

Input

  • input object
    • DBSubnetGroupDescription
    • DBSubnetGroupName required
    • SubnetIds required
      • items

Output

RebootDBInstance

amazonaws_docdb.RebootDBInstance({
  "DBInstanceIdentifier": ""
}, context)

Input

  • input object
    • DBInstanceIdentifier required string
    • ForceFailover boolean

Output

RebootDBInstance

amazonaws_docdb.RebootDBInstance({
  "DBInstanceIdentifier": null
}, context)

Input

  • input object
    • DBInstanceIdentifier required
    • ForceFailover

Output

RemoveTagsFromResource

amazonaws_docdb.RemoveTagsFromResource({
  "ResourceName": "",
  "TagKeys": []
}, context)

Input

  • input object
    • ResourceName required string
    • TagKeys required array

Output

Output schema unknown

RemoveTagsFromResource

amazonaws_docdb.RemoveTagsFromResource({
  "ResourceName": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceName required
    • TagKeys required

Output

Output schema unknown

ResetDBClusterParameterGroup

amazonaws_docdb.ResetDBClusterParameterGroup({
  "DBClusterParameterGroupName": ""
}, context)

Input

  • input object
    • DBClusterParameterGroupName required string
    • ResetAllParameters boolean
    • Parameters array

Output

ResetDBClusterParameterGroup

amazonaws_docdb.ResetDBClusterParameterGroup({
  "DBClusterParameterGroupName": null
}, context)

Input

  • input object
    • DBClusterParameterGroupName required
    • Parameters
      • items
        • AllowedValues
        • ApplyMethod
        • ApplyType
        • DataType
        • Description
        • IsModifiable
        • MinimumEngineVersion
        • ParameterName
        • ParameterValue
        • Source
    • ResetAllParameters

Output

RestoreDBClusterFromSnapshot

amazonaws_docdb.RestoreDBClusterFromSnapshot({
  "DBClusterIdentifier": "",
  "SnapshotIdentifier": "",
  "Engine": ""
}, context)

Input

  • input object
    • AvailabilityZones array
    • DBClusterIdentifier required string
    • SnapshotIdentifier required string
    • Engine required string
    • EngineVersion string
    • Port integer
    • DBSubnetGroupName string
    • VpcSecurityGroupIds array
    • Tags array
    • KmsKeyId string
    • EnableCloudwatchLogsExports array
    • DeletionProtection boolean

Output

RestoreDBClusterFromSnapshot

amazonaws_docdb.RestoreDBClusterFromSnapshot({
  "DBClusterIdentifier": null,
  "SnapshotIdentifier": null,
  "Engine": null
}, context)

Input

  • input object
    • AvailabilityZones
      • items
    • DBClusterIdentifier required
    • DBSubnetGroupName
    • DeletionProtection
    • EnableCloudwatchLogsExports
    • Engine required
    • EngineVersion
    • KmsKeyId
    • Port
    • SnapshotIdentifier required
    • Tags
      • items
        • Key
        • Value
    • VpcSecurityGroupIds
      • items

Output

RestoreDBClusterToPointInTime

amazonaws_docdb.RestoreDBClusterToPointInTime({
  "DBClusterIdentifier": "",
  "SourceDBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterIdentifier required string
    • SourceDBClusterIdentifier required string
    • RestoreToTime string
    • UseLatestRestorableTime boolean
    • Port integer
    • DBSubnetGroupName string
    • VpcSecurityGroupIds array
    • Tags array
    • KmsKeyId string
    • EnableCloudwatchLogsExports array
    • DeletionProtection boolean

Output

RestoreDBClusterToPointInTime

amazonaws_docdb.RestoreDBClusterToPointInTime({
  "DBClusterIdentifier": null,
  "SourceDBClusterIdentifier": null
}, context)

Input

  • input object
    • DBClusterIdentifier required
    • DBSubnetGroupName
    • DeletionProtection
    • EnableCloudwatchLogsExports
    • KmsKeyId
    • Port
    • RestoreToTime
    • SourceDBClusterIdentifier required
    • Tags
      • items
        • Key
        • Value
    • UseLatestRestorableTime
    • VpcSecurityGroupIds
      • items

Output

StartDBCluster

amazonaws_docdb.StartDBCluster({
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterIdentifier required string

Output

StartDBCluster

amazonaws_docdb.StartDBCluster({
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • DBClusterIdentifier required

Output

StopDBCluster

amazonaws_docdb.StopDBCluster({
  "DBClusterIdentifier": ""
}, context)

Input

  • input object
    • DBClusterIdentifier required string

Output

StopDBCluster

amazonaws_docdb.StopDBCluster({
  "DBClusterIdentifier": null
}, context)

Input

  • input object
    • DBClusterIdentifier required

Output

Definitions

AddTagsToResourceMessage

  • AddTagsToResourceMessage object: Represents the input to AddTagsToResource.
    • ResourceName required
    • Tags required
      • items
        • Key
        • Value

ApplyMethod

  • ApplyMethod string (values: immediate, pending-reboot)

ApplyPendingMaintenanceActionMessage

  • ApplyPendingMaintenanceActionMessage object: Represents the input to ApplyPendingMaintenanceAction.
    • ApplyAction required
    • OptInType required
    • ResourceIdentifier required

ApplyPendingMaintenanceActionResult

AttributeValueList

  • AttributeValueList array
    • items

AuthorizationNotFoundFault

AvailabilityZone

  • AvailabilityZone object: Information about an Availability Zone.
    • Name

AvailabilityZoneList

  • AvailabilityZoneList array
    • items
      • Name

AvailabilityZones

  • AvailabilityZones array
    • items

Boolean

  • Boolean boolean

BooleanOptional

  • BooleanOptional boolean

Certificate

  • Certificate object: A certificate authority (CA) certificate for an AWS account.
    • CertificateArn
    • CertificateIdentifier
    • CertificateType
    • Thumbprint
    • ValidFrom
    • ValidTill

CertificateList

  • CertificateList array
    • items
      • CertificateArn
      • CertificateIdentifier
      • CertificateType
      • Thumbprint
      • ValidFrom
      • ValidTill

CertificateMessage

  • CertificateMessage object
    • Certificates
      • items
        • CertificateArn
        • CertificateIdentifier
        • CertificateType
        • Thumbprint
        • ValidFrom
        • ValidTill
    • Marker

CertificateNotFoundFault

CloudwatchLogsExportConfiguration

  • CloudwatchLogsExportConfiguration object: The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.

CopyDBClusterParameterGroupMessage

  • CopyDBClusterParameterGroupMessage object: Represents the input to CopyDBClusterParameterGroup.
    • SourceDBClusterParameterGroupIdentifier required
    • Tags
      • items
        • Key
        • Value
    • TargetDBClusterParameterGroupDescription required
    • TargetDBClusterParameterGroupIdentifier required

CopyDBClusterParameterGroupResult

CopyDBClusterSnapshotMessage

  • CopyDBClusterSnapshotMessage object: Represents the input to CopyDBClusterSnapshot.
    • CopyTags
    • KmsKeyId
    • PreSignedUrl
    • SourceDBClusterSnapshotIdentifier required
    • Tags
      • items
        • Key
        • Value
    • TargetDBClusterSnapshotIdentifier required

CopyDBClusterSnapshotResult

CreateDBClusterMessage

  • CreateDBClusterMessage object: Represents the input to CreateDBCluster.
    • AvailabilityZones
      • items
    • BackupRetentionPeriod
    • DBClusterIdentifier required
    • DBClusterParameterGroupName
    • DBSubnetGroupName
    • DeletionProtection
    • EnableCloudwatchLogsExports
    • Engine required
    • EngineVersion
    • KmsKeyId
    • MasterUserPassword required
    • MasterUsername required
    • Port
    • PreSignedUrl
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • StorageEncrypted
    • Tags
      • items
        • Key
        • Value
    • VpcSecurityGroupIds
      • items

CreateDBClusterParameterGroupMessage

  • CreateDBClusterParameterGroupMessage object: Represents the input of CreateDBClusterParameterGroup.
    • DBClusterParameterGroupName required
    • DBParameterGroupFamily required
    • Description required
    • Tags
      • items
        • Key
        • Value

CreateDBClusterParameterGroupResult

CreateDBClusterResult

  • CreateDBClusterResult object

CreateDBClusterSnapshotMessage

  • CreateDBClusterSnapshotMessage object: Represents the input of CreateDBClusterSnapshot.
    • DBClusterIdentifier required
    • DBClusterSnapshotIdentifier required
    • Tags
      • items
        • Key
        • Value

CreateDBClusterSnapshotResult

CreateDBInstanceMessage

  • CreateDBInstanceMessage object: Represents the input to CreateDBInstance.
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DBClusterIdentifier required
    • DBInstanceClass required
    • DBInstanceIdentifier required
    • Engine required
    • PreferredMaintenanceWindow
    • PromotionTier
    • Tags
      • items
        • Key
        • Value

CreateDBInstanceResult

  • CreateDBInstanceResult object

CreateDBSubnetGroupMessage

  • CreateDBSubnetGroupMessage object: Represents the input to CreateDBSubnetGroup.
    • DBSubnetGroupDescription required
    • DBSubnetGroupName required
    • SubnetIds required
      • items
    • Tags
      • items
        • Key
        • Value

CreateDBSubnetGroupResult

DBCluster

  • DBCluster object: Detailed information about a cluster.
    • AssociatedRoles
      • items
        • RoleArn
        • Status
    • AvailabilityZones
      • items
    • BackupRetentionPeriod
    • ClusterCreateTime
    • DBClusterArn
    • DBClusterIdentifier
    • DBClusterMembers
      • items
        • DBClusterParameterGroupStatus
        • DBInstanceIdentifier
        • IsClusterWriter
        • PromotionTier
    • DBClusterParameterGroup
    • DBSubnetGroup
    • DbClusterResourceId
    • DeletionProtection
    • EarliestRestorableTime
    • EnabledCloudwatchLogsExports
    • Endpoint
    • Engine
    • EngineVersion
    • HostedZoneId
    • KmsKeyId
    • LatestRestorableTime
    • MasterUsername
    • MultiAZ
    • PercentProgress
    • Port
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • ReaderEndpoint
    • Status
    • StorageEncrypted
    • VpcSecurityGroups
      • items
        • Status
        • VpcSecurityGroupId

DBClusterAlreadyExistsFault

DBClusterList

  • DBClusterList array
    • items
      • AssociatedRoles
        • items
          • RoleArn
          • Status
      • AvailabilityZones
        • items
      • BackupRetentionPeriod
      • ClusterCreateTime
      • DBClusterArn
      • DBClusterIdentifier
      • DBClusterMembers
        • items
          • DBClusterParameterGroupStatus
          • DBInstanceIdentifier
          • IsClusterWriter
          • PromotionTier
      • DBClusterParameterGroup
      • DBSubnetGroup
      • DbClusterResourceId
      • DeletionProtection
      • EarliestRestorableTime
      • EnabledCloudwatchLogsExports
      • Endpoint
      • Engine
      • EngineVersion
      • HostedZoneId
      • KmsKeyId
      • LatestRestorableTime
      • MasterUsername
      • MultiAZ
      • PercentProgress
      • Port
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • ReaderEndpoint
      • Status
      • StorageEncrypted
      • VpcSecurityGroups
        • items
          • Status
          • VpcSecurityGroupId

DBClusterMember

  • DBClusterMember object: Contains information about an instance that is part of a cluster.
    • DBClusterParameterGroupStatus
    • DBInstanceIdentifier
    • IsClusterWriter
    • PromotionTier

DBClusterMemberList

  • DBClusterMemberList array
    • items
      • DBClusterParameterGroupStatus
      • DBInstanceIdentifier
      • IsClusterWriter
      • PromotionTier

DBClusterMessage

  • DBClusterMessage object: Represents the output of DescribeDBClusters.
    • DBClusters
      • items
        • AssociatedRoles
          • items
            • RoleArn
            • Status
        • AvailabilityZones
          • items
        • BackupRetentionPeriod
        • ClusterCreateTime
        • DBClusterArn
        • DBClusterIdentifier
        • DBClusterMembers
          • items
            • DBClusterParameterGroupStatus
            • DBInstanceIdentifier
            • IsClusterWriter
            • PromotionTier
        • DBClusterParameterGroup
        • DBSubnetGroup
        • DbClusterResourceId
        • DeletionProtection
        • EarliestRestorableTime
        • EnabledCloudwatchLogsExports
        • Endpoint
        • Engine
        • EngineVersion
        • HostedZoneId
        • KmsKeyId
        • LatestRestorableTime
        • MasterUsername
        • MultiAZ
        • PercentProgress
        • Port
        • PreferredBackupWindow
        • PreferredMaintenanceWindow
        • ReaderEndpoint
        • Status
        • StorageEncrypted
        • VpcSecurityGroups
          • items
            • Status
            • VpcSecurityGroupId
    • Marker

DBClusterNotFoundFault

DBClusterParameterGroup

  • DBClusterParameterGroup object: Detailed information about a cluster parameter group.
    • DBClusterParameterGroupArn
    • DBClusterParameterGroupName
    • DBParameterGroupFamily
    • Description

DBClusterParameterGroupDetails

  • DBClusterParameterGroupDetails object: Represents the output of DBClusterParameterGroup.
    • Marker
    • Parameters
      • items
        • AllowedValues
        • ApplyMethod
        • ApplyType
        • DataType
        • Description
        • IsModifiable
        • MinimumEngineVersion
        • ParameterName
        • ParameterValue
        • Source

DBClusterParameterGroupList

  • DBClusterParameterGroupList array
    • items
      • DBClusterParameterGroupArn
      • DBClusterParameterGroupName
      • DBParameterGroupFamily
      • Description

DBClusterParameterGroupNameMessage

  • DBClusterParameterGroupNameMessage object: Contains the name of a cluster parameter group.
    • DBClusterParameterGroupName

DBClusterParameterGroupNotFoundFault

DBClusterParameterGroupsMessage

  • DBClusterParameterGroupsMessage object: Represents the output of DBClusterParameterGroups.
    • DBClusterParameterGroups
      • items
        • DBClusterParameterGroupArn
        • DBClusterParameterGroupName
        • DBParameterGroupFamily
        • Description
    • Marker

DBClusterQuotaExceededFault

DBClusterRole

  • DBClusterRole object: Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.
    • RoleArn
    • Status

DBClusterRoles

  • DBClusterRoles array
    • items
      • RoleArn
      • Status

DBClusterSnapshot

  • DBClusterSnapshot object: Detailed information about a cluster snapshot.
    • AvailabilityZones
      • items
    • ClusterCreateTime
    • DBClusterIdentifier
    • DBClusterSnapshotArn
    • DBClusterSnapshotIdentifier
    • Engine
    • EngineVersion
    • KmsKeyId
    • MasterUsername
    • PercentProgress
    • Port
    • SnapshotCreateTime
    • SnapshotType
    • SourceDBClusterSnapshotArn
    • Status
    • StorageEncrypted
    • VpcId

DBClusterSnapshotAlreadyExistsFault

DBClusterSnapshotAttribute

  • DBClusterSnapshotAttribute object: Contains the name and values of a manual cluster snapshot attribute. Manual cluster snapshot attributes are used to authorize other AWS accounts to restore a manual cluster snapshot.
    • AttributeName
    • AttributeValues
      • items

DBClusterSnapshotAttributeList

  • DBClusterSnapshotAttributeList array
    • items
      • AttributeName
      • AttributeValues
        • items

DBClusterSnapshotAttributesResult

  • DBClusterSnapshotAttributesResult object: Detailed information about the attributes that are associated with a cluster snapshot.
    • DBClusterSnapshotAttributes
      • items
        • AttributeName
        • AttributeValues
          • items
    • DBClusterSnapshotIdentifier

DBClusterSnapshotList

  • DBClusterSnapshotList array
    • items
      • AvailabilityZones
        • items
      • ClusterCreateTime
      • DBClusterIdentifier
      • DBClusterSnapshotArn
      • DBClusterSnapshotIdentifier
      • Engine
      • EngineVersion
      • KmsKeyId
      • MasterUsername
      • PercentProgress
      • Port
      • SnapshotCreateTime
      • SnapshotType
      • SourceDBClusterSnapshotArn
      • Status
      • StorageEncrypted
      • VpcId

DBClusterSnapshotMessage

  • DBClusterSnapshotMessage object: Represents the output of DescribeDBClusterSnapshots.
    • DBClusterSnapshots
      • items
        • AvailabilityZones
          • items
        • ClusterCreateTime
        • DBClusterIdentifier
        • DBClusterSnapshotArn
        • DBClusterSnapshotIdentifier
        • Engine
        • EngineVersion
        • KmsKeyId
        • MasterUsername
        • PercentProgress
        • Port
        • SnapshotCreateTime
        • SnapshotType
        • SourceDBClusterSnapshotArn
        • Status
        • StorageEncrypted
        • VpcId
    • Marker

DBClusterSnapshotNotFoundFault

DBEngineVersion

  • DBEngineVersion object: Detailed information about an engine version.
    • DBEngineDescription
    • DBEngineVersionDescription
    • DBParameterGroupFamily
    • Engine
    • EngineVersion
    • ExportableLogTypes
    • SupportsLogExportsToCloudwatchLogs
    • ValidUpgradeTarget
      • items
        • AutoUpgrade
        • Description
        • Engine
        • EngineVersion
        • IsMajorVersionUpgrade

DBEngineVersionList

  • DBEngineVersionList array
    • items
      • DBEngineDescription
      • DBEngineVersionDescription
      • DBParameterGroupFamily
      • Engine
      • EngineVersion
      • ExportableLogTypes
      • SupportsLogExportsToCloudwatchLogs
      • ValidUpgradeTarget
        • items
          • AutoUpgrade
          • Description
          • Engine
          • EngineVersion
          • IsMajorVersionUpgrade

DBEngineVersionMessage

  • DBEngineVersionMessage object: Represents the output of DescribeDBEngineVersions.
    • DBEngineVersions
      • items
        • DBEngineDescription
        • DBEngineVersionDescription
        • DBParameterGroupFamily
        • Engine
        • EngineVersion
        • ExportableLogTypes
        • SupportsLogExportsToCloudwatchLogs
        • ValidUpgradeTarget
          • items
            • AutoUpgrade
            • Description
            • Engine
            • EngineVersion
            • IsMajorVersionUpgrade
    • Marker

DBInstance

  • DBInstance object: Detailed information about an instance.
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CACertificateIdentifier
    • DBClusterIdentifier
    • DBInstanceArn
    • DBInstanceClass
    • DBInstanceIdentifier
    • DBInstanceStatus
    • DBSubnetGroup
      • DBSubnetGroupArn
      • DBSubnetGroupDescription
      • DBSubnetGroupName
      • SubnetGroupStatus
      • Subnets
        • items
          • SubnetAvailabilityZone
            • Name
          • SubnetIdentifier
          • SubnetStatus
      • VpcId
    • DbiResourceId
    • EnabledCloudwatchLogsExports
    • Endpoint
      • Address
      • HostedZoneId
      • Port
    • Engine
    • EngineVersion
    • InstanceCreateTime
    • KmsKeyId
    • LatestRestorableTime
    • PendingModifiedValues
      • AllocatedStorage
      • BackupRetentionPeriod
      • CACertificateIdentifier
      • DBInstanceClass
      • DBInstanceIdentifier
      • DBSubnetGroupName
      • EngineVersion
      • Iops
      • LicenseModel
      • MasterUserPassword
      • MultiAZ
      • PendingCloudwatchLogsExports
      • Port
      • StorageType
    • PreferredBackupWindow
    • PreferredMaintenanceWindow
    • PromotionTier
    • PubliclyAccessible
    • StatusInfos
      • items
        • Message
        • Normal
        • Status
        • StatusType
    • StorageEncrypted
    • VpcSecurityGroups
      • items
        • Status
        • VpcSecurityGroupId

DBInstanceAlreadyExistsFault

DBInstanceList

  • DBInstanceList array
    • items
      • AutoMinorVersionUpgrade
      • AvailabilityZone
      • BackupRetentionPeriod
      • CACertificateIdentifier
      • DBClusterIdentifier
      • DBInstanceArn
      • DBInstanceClass
      • DBInstanceIdentifier
      • DBInstanceStatus
      • DBSubnetGroup
        • DBSubnetGroupArn
        • DBSubnetGroupDescription
        • DBSubnetGroupName
        • SubnetGroupStatus
        • Subnets
          • items
            • SubnetAvailabilityZone
            • SubnetIdentifier
            • SubnetStatus
        • VpcId
      • DbiResourceId
      • EnabledCloudwatchLogsExports
      • Endpoint
        • Address
        • HostedZoneId
        • Port
      • Engine
      • EngineVersion
      • InstanceCreateTime
      • KmsKeyId
      • LatestRestorableTime
      • PendingModifiedValues
        • AllocatedStorage
        • BackupRetentionPeriod
        • CACertificateIdentifier
        • DBInstanceClass
        • DBInstanceIdentifier
        • DBSubnetGroupName
        • EngineVersion
        • Iops
        • LicenseModel
        • MasterUserPassword
        • MultiAZ
        • PendingCloudwatchLogsExports
        • Port
        • StorageType
      • PreferredBackupWindow
      • PreferredMaintenanceWindow
      • PromotionTier
      • PubliclyAccessible
      • StatusInfos
        • items
          • Message
          • Normal
          • Status
          • StatusType
      • StorageEncrypted
      • VpcSecurityGroups
        • items
          • Status
          • VpcSecurityGroupId

DBInstanceMessage

  • DBInstanceMessage object: Represents the output of DescribeDBInstances.
    • DBInstances
      • items
        • AutoMinorVersionUpgrade
        • AvailabilityZone
        • BackupRetentionPeriod
        • CACertificateIdentifier
        • DBClusterIdentifier
        • DBInstanceArn
        • DBInstanceClass
        • DBInstanceIdentifier
        • DBInstanceStatus
        • DBSubnetGroup
          • DBSubnetGroupArn
          • DBSubnetGroupDescription
          • DBSubnetGroupName
          • SubnetGroupStatus
          • Subnets
            • items
          • VpcId
        • DbiResourceId
        • EnabledCloudwatchLogsExports
        • Endpoint
          • Address
          • HostedZoneId
          • Port
        • Engine
        • EngineVersion
        • InstanceCreateTime
        • KmsKeyId
        • LatestRestorableTime
        • PendingModifiedValues
          • AllocatedStorage
          • BackupRetentionPeriod
          • CACertificateIdentifier
          • DBInstanceClass
          • DBInstanceIdentifier
          • DBSubnetGroupName
          • EngineVersion
          • Iops
          • LicenseModel
          • MasterUserPassword
          • MultiAZ
          • PendingCloudwatchLogsExports
            • LogTypesToDisable
            • LogTypesToEnable
          • Port
          • StorageType
        • PreferredBackupWindow
        • PreferredMaintenanceWindow
        • PromotionTier
        • PubliclyAccessible
        • StatusInfos
          • items
            • Message
            • Normal
            • Status
            • StatusType
        • StorageEncrypted
        • VpcSecurityGroups
          • items
            • Status
            • VpcSecurityGroupId
    • Marker

DBInstanceNotFoundFault

DBInstanceStatusInfo

  • DBInstanceStatusInfo object: Provides a list of status information for an instance.
    • Message
    • Normal
    • Status
    • StatusType

DBInstanceStatusInfoList

  • DBInstanceStatusInfoList array
    • items
      • Message
      • Normal
      • Status
      • StatusType

DBParameterGroupAlreadyExistsFault

DBParameterGroupNotFoundFault

DBParameterGroupQuotaExceededFault

DBSecurityGroupNotFoundFault

DBSnapshotAlreadyExistsFault

DBSnapshotNotFoundFault

DBSubnetGroup

  • DBSubnetGroup object: Detailed information about a subnet group.
    • DBSubnetGroupArn
    • DBSubnetGroupDescription
    • DBSubnetGroupName
    • SubnetGroupStatus
    • Subnets
      • items
        • SubnetAvailabilityZone
          • Name
        • SubnetIdentifier
        • SubnetStatus
    • VpcId

DBSubnetGroupAlreadyExistsFault

DBSubnetGroupDoesNotCoverEnoughAZs

DBSubnetGroupMessage

  • DBSubnetGroupMessage object: Represents the output of DescribeDBSubnetGroups.
    • DBSubnetGroups
      • items
        • DBSubnetGroupArn
        • DBSubnetGroupDescription
        • DBSubnetGroupName
        • SubnetGroupStatus
        • Subnets
          • items
            • SubnetAvailabilityZone
            • SubnetIdentifier
            • SubnetStatus
        • VpcId
    • Marker

DBSubnetGroupNotFoundFault

DBSubnetGroupQuotaExceededFault

DBSubnetGroups

  • DBSubnetGroups array
    • items
      • DBSubnetGroupArn
      • DBSubnetGroupDescription
      • DBSubnetGroupName
      • SubnetGroupStatus
      • Subnets
        • items
          • SubnetAvailabilityZone
            • Name
          • SubnetIdentifier
          • SubnetStatus
      • VpcId

DBSubnetQuotaExceededFault

DBUpgradeDependencyFailureFault

DeleteDBClusterMessage

  • DeleteDBClusterMessage object: Represents the input to DeleteDBCluster.
    • DBClusterIdentifier required
    • FinalDBSnapshotIdentifier
    • SkipFinalSnapshot

DeleteDBClusterParameterGroupMessage

  • DeleteDBClusterParameterGroupMessage object: Represents the input to DeleteDBClusterParameterGroup.
    • DBClusterParameterGroupName required

DeleteDBClusterResult

  • DeleteDBClusterResult object

DeleteDBClusterSnapshotMessage

  • DeleteDBClusterSnapshotMessage object: Represents the input to DeleteDBClusterSnapshot.
    • DBClusterSnapshotIdentifier required

DeleteDBClusterSnapshotResult

DeleteDBInstanceMessage

  • DeleteDBInstanceMessage object: Represents the input to DeleteDBInstance.
    • DBInstanceIdentifier required

DeleteDBInstanceResult

  • DeleteDBInstanceResult object

DeleteDBSubnetGroupMessage

  • DeleteDBSubnetGroupMessage object: Represents the input to DeleteDBSubnetGroup.
    • DBSubnetGroupName required

DescribeCertificatesMessage

  • DescribeCertificatesMessage object
    • CertificateIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeDBClusterParameterGroupsMessage

  • DescribeDBClusterParameterGroupsMessage object: Represents the input to DescribeDBClusterParameterGroups.
    • DBClusterParameterGroupName
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeDBClusterParametersMessage

  • DescribeDBClusterParametersMessage object: Represents the input to DescribeDBClusterParameters.
    • DBClusterParameterGroupName required
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • Source

DescribeDBClusterSnapshotAttributesMessage

  • DescribeDBClusterSnapshotAttributesMessage object: Represents the input to DescribeDBClusterSnapshotAttributes.
    • DBClusterSnapshotIdentifier required

DescribeDBClusterSnapshotAttributesResult

DescribeDBClusterSnapshotsMessage

  • DescribeDBClusterSnapshotsMessage object: Represents the input to DescribeDBClusterSnapshots.
    • DBClusterIdentifier
    • DBClusterSnapshotIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • IncludePublic
    • IncludeShared
    • Marker
    • MaxRecords
    • SnapshotType

DescribeDBClustersMessage

  • DescribeDBClustersMessage object: Represents the input to DescribeDBClusters.
    • DBClusterIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeDBEngineVersionsMessage

  • DescribeDBEngineVersionsMessage object: Represents the input to DescribeDBEngineVersions.
    • DBParameterGroupFamily
    • DefaultOnly
    • Engine
    • EngineVersion
    • Filters
      • items
        • Name required
        • Values required
          • items
    • ListSupportedCharacterSets
    • ListSupportedTimezones
    • Marker
    • MaxRecords

DescribeDBInstancesMessage

  • DescribeDBInstancesMessage object: Represents the input to DescribeDBInstances.
    • DBInstanceIdentifier
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeDBSubnetGroupsMessage

  • DescribeDBSubnetGroupsMessage object: Represents the input to DescribeDBSubnetGroups.
    • DBSubnetGroupName
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeEngineDefaultClusterParametersMessage

  • DescribeEngineDefaultClusterParametersMessage object: Represents the input to DescribeEngineDefaultClusterParameters.
    • DBParameterGroupFamily required
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords

DescribeEngineDefaultClusterParametersResult

  • DescribeEngineDefaultClusterParametersResult object

DescribeEventCategoriesMessage

  • DescribeEventCategoriesMessage object: Represents the input to DescribeEventCategories.
    • Filters
      • items
        • Name required
        • Values required
          • items
    • SourceType

DescribeEventsMessage

  • DescribeEventsMessage object: Represents the input to DescribeEvents.
    • Duration
    • EndTime
    • EventCategories
      • items
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • SourceIdentifier
    • SourceType
    • StartTime

DescribeOrderableDBInstanceOptionsMessage

  • DescribeOrderableDBInstanceOptionsMessage object: Represents the input to DescribeOrderableDBInstanceOptions.
    • DBInstanceClass
    • Engine required
    • EngineVersion
    • Filters
      • items
        • Name required
        • Values required
          • items
    • LicenseModel
    • Marker
    • MaxRecords
    • Vpc

DescribePendingMaintenanceActionsMessage

  • DescribePendingMaintenanceActionsMessage object: Represents the input to DescribePendingMaintenanceActions.
    • Filters
      • items
        • Name required
        • Values required
          • items
    • Marker
    • MaxRecords
    • ResourceIdentifier

Endpoint

  • Endpoint object: Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
    • Address
    • HostedZoneId
    • Port

EngineDefaults

  • EngineDefaults object: Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.
    • DBParameterGroupFamily
    • Marker
    • Parameters
      • items
        • AllowedValues
        • ApplyMethod
        • ApplyType
        • DataType
        • Description
        • IsModifiable
        • MinimumEngineVersion
        • ParameterName
        • ParameterValue
        • Source

Event

  • Event object: Detailed information about an event.
    • Date
    • EventCategories
      • items
    • Message
    • SourceArn
    • SourceIdentifier
    • SourceType

EventCategoriesList

  • EventCategoriesList array
    • items

EventCategoriesMap

  • EventCategoriesMap object: An event source type, accompanied by one or more event category names.
    • EventCategories
      • items
    • SourceType

EventCategoriesMapList

  • EventCategoriesMapList array
    • items
      • EventCategories
        • items
      • SourceType

EventCategoriesMessage

  • EventCategoriesMessage object: Represents the output of DescribeEventCategories.
    • EventCategoriesMapList
      • items
        • EventCategories
          • items
        • SourceType

EventList

  • EventList array
    • items
      • Date
      • EventCategories
        • items
      • Message
      • SourceArn
      • SourceIdentifier
      • SourceType

EventsMessage

  • EventsMessage object: Represents the output of DescribeEvents.
    • Events
      • items
        • Date
        • EventCategories
          • items
        • Message
        • SourceArn
        • SourceIdentifier
        • SourceType
    • Marker

FailoverDBClusterMessage

  • FailoverDBClusterMessage object: Represents the input to FailoverDBCluster.
    • DBClusterIdentifier
    • TargetDBInstanceIdentifier

FailoverDBClusterResult

  • FailoverDBClusterResult object

Filter

  • Filter object: A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs. Wildcards are not supported in filters.
    • Name required
    • Values required
      • items

FilterList

  • FilterList array
    • items
      • Name required
      • Values required
        • items

FilterValueList

  • FilterValueList array
    • items

InstanceQuotaExceededFault

InsufficientDBClusterCapacityFault

InsufficientDBInstanceCapacityFault

InsufficientStorageClusterCapacityFault

Integer

  • Integer integer

IntegerOptional

  • IntegerOptional integer

InvalidDBClusterSnapshotStateFault

InvalidDBClusterStateFault

InvalidDBInstanceStateFault

InvalidDBParameterGroupStateFault

InvalidDBSecurityGroupStateFault

InvalidDBSnapshotStateFault

InvalidDBSubnetGroupStateFault

InvalidDBSubnetStateFault

InvalidRestoreFault

InvalidSubnet

InvalidVPCNetworkStateFault

KMSKeyNotAccessibleFault

KeyList

ListTagsForResourceMessage

  • ListTagsForResourceMessage object: Represents the input to ListTagsForResource.
    • Filters
      • items
        • Name required
        • Values required
          • items
    • ResourceName required

LogTypeList

ModifyDBClusterMessage

  • ModifyDBClusterMessage object: Represents the input to ModifyDBCluster.
    • ApplyImmediately
    • BackupRetentionPeriod
    • CloudwatchLogsExportConfiguration
      • DisableLogTypes
      • EnableLo