Yandex

Pulumi Official
Package maintained by Pulumi
v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

getMdbMongodbCluster

Get information about a Yandex Managed MongoDB cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbMongodbCluster.InvokeAsync(new Yandex.GetMdbMongodbClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.LookupMdbMongodbCluster(ctx, &GetMdbMongodbClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_mongodb_cluster(name="test")
pulumi.export("networkId", foo.network_id)
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = pulumi.output(yandex.getMdbMongodbCluster({
    name: "test",
}));

export const networkId = foo.networkId;

Coming soon!

Using getMdbMongodbCluster

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 getMdbMongodbCluster(args: GetMdbMongodbClusterArgs, opts?: InvokeOptions): Promise<GetMdbMongodbClusterResult>
function getMdbMongodbClusterOutput(args: GetMdbMongodbClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbMongodbClusterResult>
def get_mdb_mongodb_cluster(cluster_id: Optional[str] = None,
                            deletion_protection: Optional[bool] = None,
                            folder_id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetMdbMongodbClusterResult
def get_mdb_mongodb_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                            deletion_protection: Optional[pulumi.Input[bool]] = None,
                            folder_id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetMdbMongodbClusterResult]
func LookupMdbMongodbCluster(ctx *Context, args *LookupMdbMongodbClusterArgs, opts ...InvokeOption) (*LookupMdbMongodbClusterResult, error)
func LookupMdbMongodbClusterOutput(ctx *Context, args *LookupMdbMongodbClusterOutputArgs, opts ...InvokeOption) LookupMdbMongodbClusterResultOutput

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

public static class GetMdbMongodbCluster 
{
    public static Task<GetMdbMongodbClusterResult> InvokeAsync(GetMdbMongodbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbMongodbClusterResult> Invoke(GetMdbMongodbClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMdbMongodbClusterResult> getMdbMongodbCluster(GetMdbMongodbClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: yandex:index/getMdbMongodbCluster:getMdbMongodbCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterId string

The ID of the MongoDB cluster.

DeletionProtection bool
FolderId string

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

Name string

The name of the MongoDB cluster.

ClusterId string

The ID of the MongoDB cluster.

DeletionProtection bool
FolderId string

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

Name string

The name of the MongoDB cluster.

clusterId String

The ID of the MongoDB cluster.

deletionProtection Boolean
folderId String

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

name String

The name of the MongoDB cluster.

clusterId string

The ID of the MongoDB cluster.

deletionProtection boolean
folderId string

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

name string

The name of the MongoDB cluster.

cluster_id str

The ID of the MongoDB cluster.

deletion_protection bool
folder_id str

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

name str

The name of the MongoDB cluster.

clusterId String

The ID of the MongoDB cluster.

deletionProtection Boolean
folderId String

Folder that the resource belongs to. If value is omitted, the default provider folder is used.

name String

The name of the MongoDB cluster.

getMdbMongodbCluster Result

The following output properties are available:

ClusterConfigs List<GetMdbMongodbClusterClusterConfig>

Configuration of the MongoDB cluster. The structure is documented below.

ClusterId string
CreatedAt string

Creation timestamp of the key.

Databases List<GetMdbMongodbClusterDatabase>

A database of the MongoDB cluster. The structure is documented below.

DeletionProtection bool
Description string

Description of the MongoDB cluster.

Environment string

Deployment environment of the MongoDB cluster.

FolderId string
Health string

The health of the host.

Hosts List<GetMdbMongodbClusterHost>

A host of the MongoDB cluster. The structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to the MongoDB cluster.

MaintenanceWindows List<GetMdbMongodbClusterMaintenanceWindow>
Name string

The name of the database.

NetworkId string

ID of the network, to which the MongoDB cluster belongs.

Resources List<GetMdbMongodbClusterResource>

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

SecurityGroupIds List<string>

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

MongoDB Cluster mode enabled/disabled.

Status string

Status of the cluster.

Users List<GetMdbMongodbClusterUser>

A user of the MongoDB cluster. The structure is documented below.

ClusterConfigs []GetMdbMongodbClusterClusterConfig

Configuration of the MongoDB cluster. The structure is documented below.

ClusterId string
CreatedAt string

Creation timestamp of the key.

Databases []GetMdbMongodbClusterDatabase

A database of the MongoDB cluster. The structure is documented below.

DeletionProtection bool
Description string

Description of the MongoDB cluster.

Environment string

Deployment environment of the MongoDB cluster.

FolderId string
Health string

The health of the host.

Hosts []GetMdbMongodbClusterHost

A host of the MongoDB cluster. The structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

Labels map[string]string

A set of key/value label pairs to assign to the MongoDB cluster.

MaintenanceWindows []GetMdbMongodbClusterMaintenanceWindow
Name string

The name of the database.

NetworkId string

ID of the network, to which the MongoDB cluster belongs.

Resources []GetMdbMongodbClusterResource

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

SecurityGroupIds []string

A set of ids of security groups assigned to hosts of the cluster.

Sharded bool

MongoDB Cluster mode enabled/disabled.

Status string

Status of the cluster.

Users []GetMdbMongodbClusterUser

A user of the MongoDB cluster. The structure is documented below.

clusterConfigs ListMdbMongodbClusterClusterConfig>

Configuration of the MongoDB cluster. The structure is documented below.

clusterId String
createdAt String

Creation timestamp of the key.

databases ListMdbMongodbClusterDatabase>

A database of the MongoDB cluster. The structure is documented below.

deletionProtection Boolean
description String

Description of the MongoDB cluster.

environment String

Deployment environment of the MongoDB cluster.

folderId String
health String

The health of the host.

hosts ListMdbMongodbClusterHost>

A host of the MongoDB cluster. The structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

labels Map

A set of key/value label pairs to assign to the MongoDB cluster.

maintenanceWindows ListMdbMongodbClusterMaintenanceWindow>
name String

The name of the database.

networkId String

ID of the network, to which the MongoDB cluster belongs.

resources ListMdbMongodbClusterResource>

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

securityGroupIds List

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

MongoDB Cluster mode enabled/disabled.

status String

Status of the cluster.

users ListMdbMongodbClusterUser>

A user of the MongoDB cluster. The structure is documented below.

clusterConfigs GetMdbMongodbClusterClusterConfig[]

Configuration of the MongoDB cluster. The structure is documented below.

clusterId string
createdAt string

Creation timestamp of the key.

databases GetMdbMongodbClusterDatabase[]

A database of the MongoDB cluster. The structure is documented below.

deletionProtection boolean
description string

Description of the MongoDB cluster.

environment string

Deployment environment of the MongoDB cluster.

folderId string
health string

The health of the host.

hosts GetMdbMongodbClusterHost[]

A host of the MongoDB cluster. The structure is documented below.

id string

The provider-assigned unique ID for this managed resource.

labels {[key: string]: string}

A set of key/value label pairs to assign to the MongoDB cluster.

maintenanceWindows GetMdbMongodbClusterMaintenanceWindow[]
name string

The name of the database.

networkId string

ID of the network, to which the MongoDB cluster belongs.

resources GetMdbMongodbClusterResource[]

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

securityGroupIds string[]

A set of ids of security groups assigned to hosts of the cluster.

sharded boolean

MongoDB Cluster mode enabled/disabled.

status string

Status of the cluster.

users GetMdbMongodbClusterUser[]

A user of the MongoDB cluster. The structure is documented below.

cluster_configs Sequence[GetMdbMongodbClusterClusterConfig]

Configuration of the MongoDB cluster. The structure is documented below.

cluster_id str
created_at str

Creation timestamp of the key.

databases Sequence[GetMdbMongodbClusterDatabase]

A database of the MongoDB cluster. The structure is documented below.

deletion_protection bool
description str

Description of the MongoDB cluster.

environment str

Deployment environment of the MongoDB cluster.

folder_id str
health str

The health of the host.

hosts Sequence[GetMdbMongodbClusterHost]

A host of the MongoDB cluster. The structure is documented below.

id str

The provider-assigned unique ID for this managed resource.

labels Mapping[str, str]

A set of key/value label pairs to assign to the MongoDB cluster.

maintenance_windows Sequence[GetMdbMongodbClusterMaintenanceWindow]
name str

The name of the database.

network_id str

ID of the network, to which the MongoDB cluster belongs.

resources Sequence[GetMdbMongodbClusterResource]

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

security_group_ids Sequence[str]

A set of ids of security groups assigned to hosts of the cluster.

sharded bool

MongoDB Cluster mode enabled/disabled.

status str

Status of the cluster.

users Sequence[GetMdbMongodbClusterUser]

A user of the MongoDB cluster. The structure is documented below.

clusterConfigs List

Configuration of the MongoDB cluster. The structure is documented below.

clusterId String
createdAt String

Creation timestamp of the key.

databases List

A database of the MongoDB cluster. The structure is documented below.

deletionProtection Boolean
description String

Description of the MongoDB cluster.

environment String

Deployment environment of the MongoDB cluster.

folderId String
health String

The health of the host.

hosts List

A host of the MongoDB cluster. The structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

labels Map

A set of key/value label pairs to assign to the MongoDB cluster.

maintenanceWindows List
name String

The name of the database.

networkId String

ID of the network, to which the MongoDB cluster belongs.

resources List

Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

securityGroupIds List

A set of ids of security groups assigned to hosts of the cluster.

sharded Boolean

MongoDB Cluster mode enabled/disabled.

status String

Status of the cluster.

users List

A user of the MongoDB cluster. The structure is documented below.

Supporting Types

GetMdbMongodbClusterClusterConfig

Accesses List<GetMdbMongodbClusterClusterConfigAccess>

Access policy to MongoDB cluster. The structure is documented below.

BackupWindowStarts List<GetMdbMongodbClusterClusterConfigBackupWindowStart>

Time to start the daily backup, in the UTC timezone. The structure is documented below.

FeatureCompatibilityVersion string

Feature compatibility version of MongoDB.

Version string

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

Accesses []GetMdbMongodbClusterClusterConfigAccess

Access policy to MongoDB cluster. The structure is documented below.

BackupWindowStarts []GetMdbMongodbClusterClusterConfigBackupWindowStart

Time to start the daily backup, in the UTC timezone. The structure is documented below.

FeatureCompatibilityVersion string

Feature compatibility version of MongoDB.

Version string

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

accesses ListMdbMongodbClusterClusterConfigAccess>

Access policy to MongoDB cluster. The structure is documented below.

backupWindowStarts ListMdbMongodbClusterClusterConfigBackupWindowStart>

Time to start the daily backup, in the UTC timezone. The structure is documented below.

featureCompatibilityVersion String

Feature compatibility version of MongoDB.

version String

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

accesses GetMdbMongodbClusterClusterConfigAccess[]

Access policy to MongoDB cluster. The structure is documented below.

backupWindowStarts GetMdbMongodbClusterClusterConfigBackupWindowStart[]

Time to start the daily backup, in the UTC timezone. The structure is documented below.

featureCompatibilityVersion string

Feature compatibility version of MongoDB.

version string

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

accesses Sequence[GetMdbMongodbClusterClusterConfigAccess]

Access policy to MongoDB cluster. The structure is documented below.

backup_window_starts Sequence[GetMdbMongodbClusterClusterConfigBackupWindowStart]

Time to start the daily backup, in the UTC timezone. The structure is documented below.

feature_compatibility_version str

Feature compatibility version of MongoDB.

version str

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

accesses List

Access policy to MongoDB cluster. The structure is documented below.

backupWindowStarts List

Time to start the daily backup, in the UTC timezone. The structure is documented below.

featureCompatibilityVersion String

Feature compatibility version of MongoDB.

version String

Version of MongoDB (either 5.0, 4.4, 4.2, 4.0 or 3.6).

GetMdbMongodbClusterClusterConfigAccess

DataLens bool

Shows whether cluster has access to data lens.

DataLens bool

Shows whether cluster has access to data lens.

dataLens Boolean

Shows whether cluster has access to data lens.

dataLens boolean

Shows whether cluster has access to data lens.

data_lens bool

Shows whether cluster has access to data lens.

dataLens Boolean

Shows whether cluster has access to data lens.

GetMdbMongodbClusterClusterConfigBackupWindowStart

Hours int

The hour at which backup will be started.

Minutes int

The minute at which backup will be started.

Hours int

The hour at which backup will be started.

Minutes int

The minute at which backup will be started.

hours Integer

The hour at which backup will be started.

minutes Integer

The minute at which backup will be started.

hours number

The hour at which backup will be started.

minutes number

The minute at which backup will be started.

hours int

The hour at which backup will be started.

minutes int

The minute at which backup will be started.

hours Number

The hour at which backup will be started.

minutes Number

The minute at which backup will be started.

GetMdbMongodbClusterDatabase

Name string

The name of the MongoDB cluster.

Name string

The name of the MongoDB cluster.

name String

The name of the MongoDB cluster.

name string

The name of the MongoDB cluster.

name str

The name of the MongoDB cluster.

name String

The name of the MongoDB cluster.

GetMdbMongodbClusterHost

AssignPublicIp bool

Has assigned public IP.

Health string

The health of the host.

Name string

The name of the MongoDB cluster.

Role string

The role of the cluster (either PRIMARY or SECONDARY).

ShardName string

The name of the shard to which the host belongs.

SubnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

ZoneId string

The availability zone where the MongoDB host will be created.

AssignPublicIp bool

Has assigned public IP.

Health string

The health of the host.

Name string

The name of the MongoDB cluster.

Role string

The role of the cluster (either PRIMARY or SECONDARY).

ShardName string

The name of the shard to which the host belongs.

SubnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

ZoneId string

The availability zone where the MongoDB host will be created.

assignPublicIp Boolean

Has assigned public IP.

health String

The health of the host.

name String

The name of the MongoDB cluster.

role String

The role of the cluster (either PRIMARY or SECONDARY).

shardName String

The name of the shard to which the host belongs.

subnetId String

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

zoneId String

The availability zone where the MongoDB host will be created.

assignPublicIp boolean

Has assigned public IP.

health string

The health of the host.

name string

The name of the MongoDB cluster.

role string

The role of the cluster (either PRIMARY or SECONDARY).

shardName string

The name of the shard to which the host belongs.

subnetId string

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

zoneId string

The availability zone where the MongoDB host will be created.

assign_public_ip bool

Has assigned public IP.

health str

The health of the host.

name str

The name of the MongoDB cluster.

role str

The role of the cluster (either PRIMARY or SECONDARY).

shard_name str

The name of the shard to which the host belongs.

subnet_id str

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

type str

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

zone_id str

The availability zone where the MongoDB host will be created.

assignPublicIp Boolean

Has assigned public IP.

health String

The health of the host.

name String

The name of the MongoDB cluster.

role String

The role of the cluster (either PRIMARY or SECONDARY).

shardName String

The name of the shard to which the host belongs.

subnetId String

The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

zoneId String

The availability zone where the MongoDB host will be created.

GetMdbMongodbClusterMaintenanceWindow

Day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

Hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

Day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

Hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

Type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour Integer

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day string

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour number

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type string

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day str

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour int

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type str

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String

Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.

hour Number

Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

type String

Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

GetMdbMongodbClusterResource

DiskSize int

Volume of the storage available to a host, in gigabytes.

DiskTypeId string

The ID of the storage type. For more information, see the official documentation

ResourcePresetId string
DiskSize int

Volume of the storage available to a host, in gigabytes.

DiskTypeId string

The ID of the storage type. For more information, see the official documentation

ResourcePresetId string
diskSize Integer

Volume of the storage available to a host, in gigabytes.

diskTypeId String

The ID of the storage type. For more information, see the official documentation

resourcePresetId String
diskSize number

Volume of the storage available to a host, in gigabytes.

diskTypeId string

The ID of the storage type. For more information, see the official documentation

resourcePresetId string
disk_size int

Volume of the storage available to a host, in gigabytes.

disk_type_id str

The ID of the storage type. For more information, see the official documentation

resource_preset_id str
diskSize Number

Volume of the storage available to a host, in gigabytes.

diskTypeId String

The ID of the storage type. For more information, see the official documentation

resourcePresetId String

GetMdbMongodbClusterUser

Name string

The name of the MongoDB cluster.

Permissions List<GetMdbMongodbClusterUserPermission>

Set of permissions granted to the user. The structure is documented below.

Name string

The name of the MongoDB cluster.

Permissions []GetMdbMongodbClusterUserPermission

Set of permissions granted to the user. The structure is documented below.

name String

The name of the MongoDB cluster.

permissions ListMdbMongodbClusterUserPermission>

Set of permissions granted to the user. The structure is documented below.

name string

The name of the MongoDB cluster.

permissions GetMdbMongodbClusterUserPermission[]

Set of permissions granted to the user. The structure is documented below.

name str

The name of the MongoDB cluster.

permissions Sequence[GetMdbMongodbClusterUserPermission]

Set of permissions granted to the user. The structure is documented below.

name String

The name of the MongoDB cluster.

permissions List

Set of permissions granted to the user. The structure is documented below.

GetMdbMongodbClusterUserPermission

DatabaseName string

The name of the database that the permission grants access to.

Roles List<string>

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

DatabaseName string

The name of the database that the permission grants access to.

Roles []string

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

databaseName String

The name of the database that the permission grants access to.

roles List

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

databaseName string

The name of the database that the permission grants access to.

roles string[]

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

database_name str

The name of the database that the permission grants access to.

roles Sequence[str]

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

databaseName String

The name of the database that the permission grants access to.

roles List

(Optional) List of strings. The roles of the user in this database. For more information see the official documentation.

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes

This Pulumi package is based on the yandex Terraform Provider.