INPUT_OBJECT

MongoRecoveryRequestConfigInput

Description

Configuration for recovering MongoDB databases or collections from source to target cluster.

link GraphQL Schema definition

  • input MongoRecoveryRequestConfigInput {
  • # Supported in v9.0+
  • # Prefix for the restored collections.
  • prefix: String
  • # Supported in v9.0+
  • # Password of the target MongoDB source.
  • restoreDbPassword: String
  • # Supported in v9.0+
  • # Username of the target MongoDB source.
  • restoreDbUsername: String
  • # Specifies whether the collection can be dropped because it already exists on the
  • # target MongoDB cluster.
  • shouldDropExistingCollection: Boolean
  • # Supported in v9.0+
  • # List of MongoDB collection objects.
  • sourceCollectionIds: [String!]
  • # Supported in v9.0+
  • # List of MongoDB database objects.
  • sourceDatabaseIds: [String!]
  • # Supported in v9.0+
  • # Name of the target collection for recovery.
  • targetCollectionName: String
  • # Supported in v9.0+
  • # Name of the target database for recovery.
  • targetDatabaseName: String
  • # Required. Supported in v9.0+
  • # Timestamp of the snapshot version to be used for restore.
  • versionTime: DateTime
  • # Supported in v9.0+
  • # Rate limit restore data ingestion on target MongoDB cluster.
  • restoreThrottleInBytesPerSecond: Long
  • # Supported in v9.0+
  • # Boolean flag to restore MongoDB collections with index.
  • isRestoreWithIndex: Boolean
  • # Supported in v9.0+
  • # v9.0: Type of user authentication used when recovering to a target MongoDB
  • # cluster. If no specific option is provided, the authentication mechanism used
  • # for recovery in the target MongoDB cluster will be the one that was originally
  • # used when adding the target MongoDB cluster.
  • # v9.1+: Type of user authentication used when recovering to a target MongoDB
  • # cluster. If no option is provided, the one used during adding the target source
  • # will be used.
  • targetAuthenticationType: MongoAuthenticationType
  • # Required. Supported in v9.0+
  • # ID of the MongoDB source cluster.
  • sourceMongoClusterId: String!
  • # Required. Supported in v9.0+
  • # ID of the MongoDB target cluster.
  • targetMongoClusterId: String!
  • }