1. Packages
  2. stackit
  3. API Docs
  4. getMongodbflexInstance
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

    MongoDB Flex instance data source schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_mongodbflex_instance" "example" {
      project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    

    Using getMongodbflexInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMongodbflexInstance(args: GetMongodbflexInstanceArgs, opts?: InvokeOptions): Promise<GetMongodbflexInstanceResult>
    function getMongodbflexInstanceOutput(args: GetMongodbflexInstanceOutputArgs, opts?: InvokeOptions): Output<GetMongodbflexInstanceResult>
    def get_mongodbflex_instance(instance_id: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 region: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetMongodbflexInstanceResult
    def get_mongodbflex_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                                 project_id: Optional[pulumi.Input[str]] = None,
                                 region: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetMongodbflexInstanceResult]
    func LookupMongodbflexInstance(ctx *Context, args *LookupMongodbflexInstanceArgs, opts ...InvokeOption) (*LookupMongodbflexInstanceResult, error)
    func LookupMongodbflexInstanceOutput(ctx *Context, args *LookupMongodbflexInstanceOutputArgs, opts ...InvokeOption) LookupMongodbflexInstanceResultOutput

    > Note: This function is named LookupMongodbflexInstance in the Go SDK.

    public static class GetMongodbflexInstance 
    {
        public static Task<GetMongodbflexInstanceResult> InvokeAsync(GetMongodbflexInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetMongodbflexInstanceResult> Invoke(GetMongodbflexInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMongodbflexInstanceResult> getMongodbflexInstance(GetMongodbflexInstanceArgs args, InvokeOptions options)
    public static Output<GetMongodbflexInstanceResult> getMongodbflexInstance(GetMongodbflexInstanceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: stackit:index/getMongodbflexInstance:getMongodbflexInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    ID of the MongoDB Flex instance.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    InstanceId string
    ID of the MongoDB Flex instance.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    instanceId String
    ID of the MongoDB Flex instance.
    projectId String
    STACKIT project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.
    instanceId string
    ID of the MongoDB Flex instance.
    projectId string
    STACKIT project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    instance_id str
    ID of the MongoDB Flex instance.
    project_id str
    STACKIT project ID to which the instance is associated.
    region str
    The resource region. If not defined, the provider region is used.
    instanceId String
    ID of the MongoDB Flex instance.
    projectId String
    STACKIT project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.

    getMongodbflexInstance Result

    The following output properties are available:

    Acls List<string>
    The Access Control List (ACL) for the MongoDB Flex instance.
    BackupSchedule string
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    Flavor GetMongodbflexInstanceFlavor
    Id string
    InstanceId string
    ID of the MongoDB Flex instance.
    Name string
    Instance name.
    Options GetMongodbflexInstanceOptions
    Custom parameters for the MongoDB Flex instance.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Replicas int
    Storage GetMongodbflexInstanceStorage
    Version string
    Acls []string
    The Access Control List (ACL) for the MongoDB Flex instance.
    BackupSchedule string
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    Flavor GetMongodbflexInstanceFlavor
    Id string
    InstanceId string
    ID of the MongoDB Flex instance.
    Name string
    Instance name.
    Options GetMongodbflexInstanceOptions
    Custom parameters for the MongoDB Flex instance.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Replicas int
    Storage GetMongodbflexInstanceStorage
    Version string
    acls List<String>
    The Access Control List (ACL) for the MongoDB Flex instance.
    backupSchedule String
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    flavor GetMongodbflexInstanceFlavor
    id String
    instanceId String
    ID of the MongoDB Flex instance.
    name String
    Instance name.
    options GetMongodbflexInstanceOptions
    Custom parameters for the MongoDB Flex instance.
    projectId String
    STACKIT project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.
    replicas Integer
    storage GetMongodbflexInstanceStorage
    version String
    acls string[]
    The Access Control List (ACL) for the MongoDB Flex instance.
    backupSchedule string
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    flavor GetMongodbflexInstanceFlavor
    id string
    instanceId string
    ID of the MongoDB Flex instance.
    name string
    Instance name.
    options GetMongodbflexInstanceOptions
    Custom parameters for the MongoDB Flex instance.
    projectId string
    STACKIT project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    replicas number
    storage GetMongodbflexInstanceStorage
    version string
    acls Sequence[str]
    The Access Control List (ACL) for the MongoDB Flex instance.
    backup_schedule str
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    flavor GetMongodbflexInstanceFlavor
    id str
    instance_id str
    ID of the MongoDB Flex instance.
    name str
    Instance name.
    options GetMongodbflexInstanceOptions
    Custom parameters for the MongoDB Flex instance.
    project_id str
    STACKIT project ID to which the instance is associated.
    region str
    The resource region. If not defined, the provider region is used.
    replicas int
    storage GetMongodbflexInstanceStorage
    version str
    acls List<String>
    The Access Control List (ACL) for the MongoDB Flex instance.
    backupSchedule String
    The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
    flavor Property Map
    id String
    instanceId String
    ID of the MongoDB Flex instance.
    name String
    Instance name.
    options Property Map
    Custom parameters for the MongoDB Flex instance.
    projectId String
    STACKIT project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.
    replicas Number
    storage Property Map
    version String

    Supporting Types

    GetMongodbflexInstanceFlavor

    Cpu int
    Description string
    Id string
    Ram int
    Cpu int
    Description string
    Id string
    Ram int
    cpu Integer
    description String
    id String
    ram Integer
    cpu number
    description string
    id string
    ram number
    cpu int
    description str
    id str
    ram int
    cpu Number
    description String
    id String
    ram Number

    GetMongodbflexInstanceOptions

    DailySnapshotRetentionDays int
    The number of days that daily backups will be retained.
    MonthlySnapshotRetentionMonths int
    The number of months that monthly backups will be retained.
    PointInTimeWindowHours int
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    SnapshotRetentionDays int
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    Type string
    Type of the MongoDB Flex instance.
    WeeklySnapshotRetentionWeeks int
    The number of weeks that weekly backups will be retained.
    DailySnapshotRetentionDays int
    The number of days that daily backups will be retained.
    MonthlySnapshotRetentionMonths int
    The number of months that monthly backups will be retained.
    PointInTimeWindowHours int
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    SnapshotRetentionDays int
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    Type string
    Type of the MongoDB Flex instance.
    WeeklySnapshotRetentionWeeks int
    The number of weeks that weekly backups will be retained.
    dailySnapshotRetentionDays Integer
    The number of days that daily backups will be retained.
    monthlySnapshotRetentionMonths Integer
    The number of months that monthly backups will be retained.
    pointInTimeWindowHours Integer
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    snapshotRetentionDays Integer
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    type String
    Type of the MongoDB Flex instance.
    weeklySnapshotRetentionWeeks Integer
    The number of weeks that weekly backups will be retained.
    dailySnapshotRetentionDays number
    The number of days that daily backups will be retained.
    monthlySnapshotRetentionMonths number
    The number of months that monthly backups will be retained.
    pointInTimeWindowHours number
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    snapshotRetentionDays number
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    type string
    Type of the MongoDB Flex instance.
    weeklySnapshotRetentionWeeks number
    The number of weeks that weekly backups will be retained.
    daily_snapshot_retention_days int
    The number of days that daily backups will be retained.
    monthly_snapshot_retention_months int
    The number of months that monthly backups will be retained.
    point_in_time_window_hours int
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    snapshot_retention_days int
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    type str
    Type of the MongoDB Flex instance.
    weekly_snapshot_retention_weeks int
    The number of weeks that weekly backups will be retained.
    dailySnapshotRetentionDays Number
    The number of days that daily backups will be retained.
    monthlySnapshotRetentionMonths Number
    The number of months that monthly backups will be retained.
    pointInTimeWindowHours Number
    The number of hours back in time the point-in-time recovery feature will be able to recover.
    snapshotRetentionDays Number
    The number of days that continuous backups (controlled via the backup_schedule) will be retained.
    type String
    Type of the MongoDB Flex instance.
    weeklySnapshotRetentionWeeks Number
    The number of weeks that weekly backups will be retained.

    GetMongodbflexInstanceStorage

    Class string
    Size int
    Class string
    Size int
    class_ String
    size Integer
    class string
    size number
    class_ str
    size int
    class String
    size Number

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
      Try Pulumi Cloud free. Your team will thank you.