yandex.MdbMongodbCluster
Explore with Pulumi AI
Manages a MongoDB cluster within the Yandex.Cloud. For more information, see the official documentation.
Example Usage
Example of creating a Single Node MongoDB.
using Pulumi;
using Yandex = Pulumi.Yandex;
class MyStack : Stack
{
public MyStack()
{
var fooVpcNetwork = new Yandex.VpcNetwork("fooVpcNetwork", new Yandex.VpcNetworkArgs
{
});
var fooVpcSubnet = new Yandex.VpcSubnet("fooVpcSubnet", new Yandex.VpcSubnetArgs
{
NetworkId = fooVpcNetwork.Id,
V4CidrBlocks =
{
"10.1.0.0/24",
},
Zone = "ru-central1-a",
});
var fooMdbMongodbCluster = new Yandex.MdbMongodbCluster("fooMdbMongodbCluster", new Yandex.MdbMongodbClusterArgs
{
ClusterConfig = new Yandex.Inputs.MdbMongodbClusterClusterConfigArgs
{
Version = "4.2",
},
Databases =
{
new Yandex.Inputs.MdbMongodbClusterDatabaseArgs
{
Name = "testdb",
},
},
Environment = "PRESTABLE",
Hosts =
{
new Yandex.Inputs.MdbMongodbClusterHostArgs
{
SubnetId = fooVpcSubnet.Id,
ZoneId = "ru-central1-a",
},
},
Labels =
{
{ "test_key", "test_value" },
},
MaintenanceWindow = new Yandex.Inputs.MdbMongodbClusterMaintenanceWindowArgs
{
Type = "ANYTIME",
},
NetworkId = fooVpcNetwork.Id,
Resources = new Yandex.Inputs.MdbMongodbClusterResourcesArgs
{
DiskSize = 16,
DiskTypeId = "network-hdd",
ResourcePresetId = "b1.nano",
},
Users =
{
new Yandex.Inputs.MdbMongodbClusterUserArgs
{
Name = "john",
Password = "password",
Permissions =
{
new Yandex.Inputs.MdbMongodbClusterUserPermissionArgs
{
DatabaseName = "testdb",
},
},
},
},
});
}
}
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 {
fooVpcNetwork, err := yandex.NewVpcNetwork(ctx, "fooVpcNetwork", nil)
if err != nil {
return err
}
fooVpcSubnet, err := yandex.NewVpcSubnet(ctx, "fooVpcSubnet", &yandex.VpcSubnetArgs{
NetworkId: fooVpcNetwork.ID(),
V4CidrBlocks: pulumi.StringArray{
pulumi.String("10.1.0.0/24"),
},
Zone: pulumi.String("ru-central1-a"),
})
if err != nil {
return err
}
_, err = yandex.NewMdbMongodbCluster(ctx, "fooMdbMongodbCluster", &yandex.MdbMongodbClusterArgs{
ClusterConfig: &MdbMongodbClusterClusterConfigArgs{
Version: pulumi.String("4.2"),
},
Databases: MdbMongodbClusterDatabaseArray{
&MdbMongodbClusterDatabaseArgs{
Name: pulumi.String("testdb"),
},
},
Environment: pulumi.String("PRESTABLE"),
Hosts: MdbMongodbClusterHostArray{
&MdbMongodbClusterHostArgs{
SubnetId: fooVpcSubnet.ID(),
ZoneId: pulumi.String("ru-central1-a"),
},
},
Labels: pulumi.StringMap{
"test_key": pulumi.String("test_value"),
},
MaintenanceWindow: &MdbMongodbClusterMaintenanceWindowArgs{
Type: pulumi.String("ANYTIME"),
},
NetworkId: fooVpcNetwork.ID(),
Resources: &MdbMongodbClusterResourcesArgs{
DiskSize: pulumi.Int(16),
DiskTypeId: pulumi.String("network-hdd"),
ResourcePresetId: pulumi.String("b1.nano"),
},
Users: MdbMongodbClusterUserArray{
&MdbMongodbClusterUserArgs{
Name: pulumi.String("john"),
Password: pulumi.String("password"),
Permissions: MdbMongodbClusterUserPermissionArray{
&MdbMongodbClusterUserPermissionArgs{
DatabaseName: pulumi.String("testdb"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_yandex as yandex
foo_vpc_network = yandex.VpcNetwork("fooVpcNetwork")
foo_vpc_subnet = yandex.VpcSubnet("fooVpcSubnet",
network_id=foo_vpc_network.id,
v4_cidr_blocks=["10.1.0.0/24"],
zone="ru-central1-a")
foo_mdb_mongodb_cluster = yandex.MdbMongodbCluster("fooMdbMongodbCluster",
cluster_config=yandex.MdbMongodbClusterClusterConfigArgs(
version="4.2",
),
databases=[yandex.MdbMongodbClusterDatabaseArgs(
name="testdb",
)],
environment="PRESTABLE",
hosts=[yandex.MdbMongodbClusterHostArgs(
subnet_id=foo_vpc_subnet.id,
zone_id="ru-central1-a",
)],
labels={
"test_key": "test_value",
},
maintenance_window=yandex.MdbMongodbClusterMaintenanceWindowArgs(
type="ANYTIME",
),
network_id=foo_vpc_network.id,
resources=yandex.MdbMongodbClusterResourcesArgs(
disk_size=16,
disk_type_id="network-hdd",
resource_preset_id="b1.nano",
),
users=[yandex.MdbMongodbClusterUserArgs(
name="john",
password="password",
permissions=[yandex.MdbMongodbClusterUserPermissionArgs(
database_name="testdb",
)],
)])
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";
const fooVpcNetwork = new yandex.VpcNetwork("foo", {});
const fooVpcSubnet = new yandex.VpcSubnet("foo", {
networkId: fooVpcNetwork.id,
v4CidrBlocks: ["10.1.0.0/24"],
zone: "ru-central1-a",
});
const fooMdbMongodbCluster = new yandex.MdbMongodbCluster("foo", {
clusterConfig: {
version: "4.2",
},
databases: [{
name: "testdb",
}],
environment: "PRESTABLE",
hosts: [{
subnetId: fooVpcSubnet.id,
zoneId: "ru-central1-a",
}],
labels: {
test_key: "test_value",
},
maintenanceWindow: {
type: "ANYTIME",
},
networkId: fooVpcNetwork.id,
resources: {
diskSize: 16,
diskTypeId: "network-hdd",
resourcePresetId: "b1.nano",
},
users: [{
name: "john",
password: "password",
permissions: [{
databaseName: "testdb",
}],
}],
});
Coming soon!
Create MdbMongodbCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MdbMongodbCluster(name: string, args: MdbMongodbClusterArgs, opts?: CustomResourceOptions);
@overload
def MdbMongodbCluster(resource_name: str,
args: MdbMongodbClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MdbMongodbCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
hosts: Optional[Sequence[MdbMongodbClusterHostArgs]] = None,
users: Optional[Sequence[MdbMongodbClusterUserArgs]] = None,
databases: Optional[Sequence[MdbMongodbClusterDatabaseArgs]] = None,
resources: Optional[MdbMongodbClusterResourcesArgs] = None,
network_id: Optional[str] = None,
environment: Optional[str] = None,
cluster_config: Optional[MdbMongodbClusterClusterConfigArgs] = None,
folder_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
maintenance_window: Optional[MdbMongodbClusterMaintenanceWindowArgs] = None,
name: Optional[str] = None,
description: Optional[str] = None,
deletion_protection: Optional[bool] = None,
security_group_ids: Optional[Sequence[str]] = None,
cluster_id: Optional[str] = None)
func NewMdbMongodbCluster(ctx *Context, name string, args MdbMongodbClusterArgs, opts ...ResourceOption) (*MdbMongodbCluster, error)
public MdbMongodbCluster(string name, MdbMongodbClusterArgs args, CustomResourceOptions? opts = null)
public MdbMongodbCluster(String name, MdbMongodbClusterArgs args)
public MdbMongodbCluster(String name, MdbMongodbClusterArgs args, CustomResourceOptions options)
type: yandex:MdbMongodbCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MdbMongodbClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MdbMongodbClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MdbMongodbClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MdbMongodbClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MdbMongodbClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var mdbMongodbClusterResource = new Yandex.MdbMongodbCluster("mdbMongodbClusterResource", new()
{
Hosts = new[]
{
new Yandex.Inputs.MdbMongodbClusterHostArgs
{
SubnetId = "string",
ZoneId = "string",
AssignPublicIp = false,
Health = "string",
Name = "string",
Role = "string",
ShardName = "string",
Type = "string",
},
},
Users = new[]
{
new Yandex.Inputs.MdbMongodbClusterUserArgs
{
Name = "string",
Password = "string",
Permissions = new[]
{
new Yandex.Inputs.MdbMongodbClusterUserPermissionArgs
{
DatabaseName = "string",
Roles = new[]
{
"string",
},
},
},
},
},
Databases = new[]
{
new Yandex.Inputs.MdbMongodbClusterDatabaseArgs
{
Name = "string",
},
},
Resources = new Yandex.Inputs.MdbMongodbClusterResourcesArgs
{
DiskSize = 0,
DiskTypeId = "string",
ResourcePresetId = "string",
},
NetworkId = "string",
Environment = "string",
ClusterConfig = new Yandex.Inputs.MdbMongodbClusterClusterConfigArgs
{
Version = "string",
Access = new Yandex.Inputs.MdbMongodbClusterClusterConfigAccessArgs
{
DataLens = false,
},
BackupWindowStart = new Yandex.Inputs.MdbMongodbClusterClusterConfigBackupWindowStartArgs
{
Hours = 0,
Minutes = 0,
},
FeatureCompatibilityVersion = "string",
},
FolderId = "string",
Labels =
{
{ "string", "string" },
},
MaintenanceWindow = new Yandex.Inputs.MdbMongodbClusterMaintenanceWindowArgs
{
Type = "string",
Day = "string",
Hour = 0,
},
Name = "string",
Description = "string",
DeletionProtection = false,
SecurityGroupIds = new[]
{
"string",
},
ClusterId = "string",
});
example, err := yandex.NewMdbMongodbCluster(ctx, "mdbMongodbClusterResource", &yandex.MdbMongodbClusterArgs{
Hosts: yandex.MdbMongodbClusterHostArray{
&yandex.MdbMongodbClusterHostArgs{
SubnetId: pulumi.String("string"),
ZoneId: pulumi.String("string"),
AssignPublicIp: pulumi.Bool(false),
Health: pulumi.String("string"),
Name: pulumi.String("string"),
Role: pulumi.String("string"),
ShardName: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Users: yandex.MdbMongodbClusterUserArray{
&yandex.MdbMongodbClusterUserArgs{
Name: pulumi.String("string"),
Password: pulumi.String("string"),
Permissions: yandex.MdbMongodbClusterUserPermissionArray{
&yandex.MdbMongodbClusterUserPermissionArgs{
DatabaseName: pulumi.String("string"),
Roles: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
},
Databases: yandex.MdbMongodbClusterDatabaseArray{
&yandex.MdbMongodbClusterDatabaseArgs{
Name: pulumi.String("string"),
},
},
Resources: &yandex.MdbMongodbClusterResourcesArgs{
DiskSize: pulumi.Int(0),
DiskTypeId: pulumi.String("string"),
ResourcePresetId: pulumi.String("string"),
},
NetworkId: pulumi.String("string"),
Environment: pulumi.String("string"),
ClusterConfig: &yandex.MdbMongodbClusterClusterConfigArgs{
Version: pulumi.String("string"),
Access: &yandex.MdbMongodbClusterClusterConfigAccessArgs{
DataLens: pulumi.Bool(false),
},
BackupWindowStart: &yandex.MdbMongodbClusterClusterConfigBackupWindowStartArgs{
Hours: pulumi.Int(0),
Minutes: pulumi.Int(0),
},
FeatureCompatibilityVersion: pulumi.String("string"),
},
FolderId: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
MaintenanceWindow: &yandex.MdbMongodbClusterMaintenanceWindowArgs{
Type: pulumi.String("string"),
Day: pulumi.String("string"),
Hour: pulumi.Int(0),
},
Name: pulumi.String("string"),
Description: pulumi.String("string"),
DeletionProtection: pulumi.Bool(false),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
ClusterId: pulumi.String("string"),
})
var mdbMongodbClusterResource = new MdbMongodbCluster("mdbMongodbClusterResource", MdbMongodbClusterArgs.builder()
.hosts(MdbMongodbClusterHostArgs.builder()
.subnetId("string")
.zoneId("string")
.assignPublicIp(false)
.health("string")
.name("string")
.role("string")
.shardName("string")
.type("string")
.build())
.users(MdbMongodbClusterUserArgs.builder()
.name("string")
.password("string")
.permissions(MdbMongodbClusterUserPermissionArgs.builder()
.databaseName("string")
.roles("string")
.build())
.build())
.databases(MdbMongodbClusterDatabaseArgs.builder()
.name("string")
.build())
.resources(MdbMongodbClusterResourcesArgs.builder()
.diskSize(0)
.diskTypeId("string")
.resourcePresetId("string")
.build())
.networkId("string")
.environment("string")
.clusterConfig(MdbMongodbClusterClusterConfigArgs.builder()
.version("string")
.access(MdbMongodbClusterClusterConfigAccessArgs.builder()
.dataLens(false)
.build())
.backupWindowStart(MdbMongodbClusterClusterConfigBackupWindowStartArgs.builder()
.hours(0)
.minutes(0)
.build())
.featureCompatibilityVersion("string")
.build())
.folderId("string")
.labels(Map.of("string", "string"))
.maintenanceWindow(MdbMongodbClusterMaintenanceWindowArgs.builder()
.type("string")
.day("string")
.hour(0)
.build())
.name("string")
.description("string")
.deletionProtection(false)
.securityGroupIds("string")
.clusterId("string")
.build());
mdb_mongodb_cluster_resource = yandex.MdbMongodbCluster("mdbMongodbClusterResource",
hosts=[{
"subnet_id": "string",
"zone_id": "string",
"assign_public_ip": False,
"health": "string",
"name": "string",
"role": "string",
"shard_name": "string",
"type": "string",
}],
users=[{
"name": "string",
"password": "string",
"permissions": [{
"database_name": "string",
"roles": ["string"],
}],
}],
databases=[{
"name": "string",
}],
resources={
"disk_size": 0,
"disk_type_id": "string",
"resource_preset_id": "string",
},
network_id="string",
environment="string",
cluster_config={
"version": "string",
"access": {
"data_lens": False,
},
"backup_window_start": {
"hours": 0,
"minutes": 0,
},
"feature_compatibility_version": "string",
},
folder_id="string",
labels={
"string": "string",
},
maintenance_window={
"type": "string",
"day": "string",
"hour": 0,
},
name="string",
description="string",
deletion_protection=False,
security_group_ids=["string"],
cluster_id="string")
const mdbMongodbClusterResource = new yandex.MdbMongodbCluster("mdbMongodbClusterResource", {
hosts: [{
subnetId: "string",
zoneId: "string",
assignPublicIp: false,
health: "string",
name: "string",
role: "string",
shardName: "string",
type: "string",
}],
users: [{
name: "string",
password: "string",
permissions: [{
databaseName: "string",
roles: ["string"],
}],
}],
databases: [{
name: "string",
}],
resources: {
diskSize: 0,
diskTypeId: "string",
resourcePresetId: "string",
},
networkId: "string",
environment: "string",
clusterConfig: {
version: "string",
access: {
dataLens: false,
},
backupWindowStart: {
hours: 0,
minutes: 0,
},
featureCompatibilityVersion: "string",
},
folderId: "string",
labels: {
string: "string",
},
maintenanceWindow: {
type: "string",
day: "string",
hour: 0,
},
name: "string",
description: "string",
deletionProtection: false,
securityGroupIds: ["string"],
clusterId: "string",
});
type: yandex:MdbMongodbCluster
properties:
clusterConfig:
access:
dataLens: false
backupWindowStart:
hours: 0
minutes: 0
featureCompatibilityVersion: string
version: string
clusterId: string
databases:
- name: string
deletionProtection: false
description: string
environment: string
folderId: string
hosts:
- assignPublicIp: false
health: string
name: string
role: string
shardName: string
subnetId: string
type: string
zoneId: string
labels:
string: string
maintenanceWindow:
day: string
hour: 0
type: string
name: string
networkId: string
resources:
diskSize: 0
diskTypeId: string
resourcePresetId: string
securityGroupIds:
- string
users:
- name: string
password: string
permissions:
- databaseName: string
roles:
- string
MdbMongodbCluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MdbMongodbCluster resource accepts the following input properties:
- Cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- Databases
List<Mdb
Mongodb Cluster Database> - A database of the MongoDB cluster. The structure is documented below.
- Environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - Hosts
List<Mdb
Mongodb Cluster Host> - A host of the MongoDB cluster. The structure is documented below.
- Network
Id string - ID of the network, to which the MongoDB cluster belongs.
- Resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- Users
List<Mdb
Mongodb Cluster User> - A user of the MongoDB cluster. The structure is documented below.
- Cluster
Id string - The ID of the cluster.
- Deletion
Protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - Description string
- Description of the MongoDB cluster.
- Folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- Labels Dictionary<string, string>
- A set of key/value label pairs to assign to the MongoDB cluster.
- Maintenance
Window MdbMongodb Cluster Maintenance Window - Name string
- The fully qualified domain name of the host. Computed on server side.
- Security
Group List<string>Ids - A set of ids of security groups assigned to hosts of the cluster.
- Cluster
Config MdbMongodb Cluster Cluster Config Args - Configuration of the MongoDB subcluster. The structure is documented below.
- Databases
[]Mdb
Mongodb Cluster Database Args - A database of the MongoDB cluster. The structure is documented below.
- Environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - Hosts
[]Mdb
Mongodb Cluster Host Args - A host of the MongoDB cluster. The structure is documented below.
- Network
Id string - ID of the network, to which the MongoDB cluster belongs.
- Resources
Mdb
Mongodb Cluster Resources Args - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- Users
[]Mdb
Mongodb Cluster User Args - A user of the MongoDB cluster. The structure is documented below.
- Cluster
Id string - The ID of the cluster.
- Deletion
Protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - Description string
- Description of the MongoDB cluster.
- Folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- Labels map[string]string
- A set of key/value label pairs to assign to the MongoDB cluster.
- Maintenance
Window MdbMongodb Cluster Maintenance Window Args - Name string
- The fully qualified domain name of the host. Computed on server side.
- Security
Group []stringIds - A set of ids of security groups assigned to hosts of the cluster.
- cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- databases
List<Mdb
Mongodb Cluster Database> - A database of the MongoDB cluster. The structure is documented below.
- environment String
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - hosts
List<Mdb
Mongodb Cluster Host> - A host of the MongoDB cluster. The structure is documented below.
- network
Id String - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- users
List<Mdb
Mongodb Cluster User> - A user of the MongoDB cluster. The structure is documented below.
- cluster
Id String - The ID of the cluster.
- deletion
Protection Boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description String
- Description of the MongoDB cluster.
- folder
Id String - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- labels Map<String,String>
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window MdbMongodb Cluster Maintenance Window - name String
- The fully qualified domain name of the host. Computed on server side.
- security
Group List<String>Ids - A set of ids of security groups assigned to hosts of the cluster.
- cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- databases
Mdb
Mongodb Cluster Database[] - A database of the MongoDB cluster. The structure is documented below.
- environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - hosts
Mdb
Mongodb Cluster Host[] - A host of the MongoDB cluster. The structure is documented below.
- network
Id string - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- users
Mdb
Mongodb Cluster User[] - A user of the MongoDB cluster. The structure is documented below.
- cluster
Id string - The ID of the cluster.
- deletion
Protection boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description string
- Description of the MongoDB cluster.
- folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- labels {[key: string]: string}
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window MdbMongodb Cluster Maintenance Window - name string
- The fully qualified domain name of the host. Computed on server side.
- security
Group string[]Ids - A set of ids of security groups assigned to hosts of the cluster.
- cluster_
config MdbMongodb Cluster Cluster Config Args - Configuration of the MongoDB subcluster. The structure is documented below.
- databases
Sequence[Mdb
Mongodb Cluster Database Args] - A database of the MongoDB cluster. The structure is documented below.
- environment str
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - hosts
Sequence[Mdb
Mongodb Cluster Host Args] - A host of the MongoDB cluster. The structure is documented below.
- network_
id str - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources Args - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- users
Sequence[Mdb
Mongodb Cluster User Args] - A user of the MongoDB cluster. The structure is documented below.
- cluster_
id str - The ID of the cluster.
- deletion_
protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description str
- Description of the MongoDB cluster.
- folder_
id str - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- labels Mapping[str, str]
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance_
window MdbMongodb Cluster Maintenance Window Args - name str
- The fully qualified domain name of the host. Computed on server side.
- security_
group_ Sequence[str]ids - A set of ids of security groups assigned to hosts of the cluster.
- cluster
Config Property Map - Configuration of the MongoDB subcluster. The structure is documented below.
- databases List<Property Map>
- A database of the MongoDB cluster. The structure is documented below.
- environment String
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - hosts List<Property Map>
- A host of the MongoDB cluster. The structure is documented below.
- network
Id String - ID of the network, to which the MongoDB cluster belongs.
- resources Property Map
- Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- users List<Property Map>
- A user of the MongoDB cluster. The structure is documented below.
- cluster
Id String - The ID of the cluster.
- deletion
Protection Boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description String
- Description of the MongoDB cluster.
- folder
Id String - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- labels Map<String>
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window Property Map - name String
- The fully qualified domain name of the host. Computed on server side.
- security
Group List<String>Ids - A set of ids of security groups assigned to hosts of the cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the MdbMongodbCluster resource produces the following output properties:
- Created
At string - Creation timestamp of the key.
- Health string
- The health of the host.
- Id string
- The provider-assigned unique ID for this managed resource.
- bool
- MongoDB Cluster mode enabled/disabled.
- Status string
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
- Created
At string - Creation timestamp of the key.
- Health string
- The health of the host.
- Id string
- The provider-assigned unique ID for this managed resource.
- bool
- MongoDB Cluster mode enabled/disabled.
- Status string
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
- created
At String - Creation timestamp of the key.
- health String
- The health of the host.
- id String
- The provider-assigned unique ID for this managed resource.
- Boolean
- MongoDB Cluster mode enabled/disabled.
- status String
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
- created
At string - Creation timestamp of the key.
- health string
- The health of the host.
- id string
- The provider-assigned unique ID for this managed resource.
- boolean
- MongoDB Cluster mode enabled/disabled.
- status string
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
- created_
at str - Creation timestamp of the key.
- health str
- The health of the host.
- id str
- The provider-assigned unique ID for this managed resource.
- bool
- MongoDB Cluster mode enabled/disabled.
- status str
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
- created
At String - Creation timestamp of the key.
- health String
- The health of the host.
- id String
- The provider-assigned unique ID for this managed resource.
- Boolean
- MongoDB Cluster mode enabled/disabled.
- status String
- Status of the cluster. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation.
Look up Existing MdbMongodbCluster Resource
Get an existing MdbMongodbCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: MdbMongodbClusterState, opts?: CustomResourceOptions): MdbMongodbCluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cluster_config: Optional[MdbMongodbClusterClusterConfigArgs] = None,
cluster_id: Optional[str] = None,
created_at: Optional[str] = None,
databases: Optional[Sequence[MdbMongodbClusterDatabaseArgs]] = None,
deletion_protection: Optional[bool] = None,
description: Optional[str] = None,
environment: Optional[str] = None,
folder_id: Optional[str] = None,
health: Optional[str] = None,
hosts: Optional[Sequence[MdbMongodbClusterHostArgs]] = None,
labels: Optional[Mapping[str, str]] = None,
maintenance_window: Optional[MdbMongodbClusterMaintenanceWindowArgs] = None,
name: Optional[str] = None,
network_id: Optional[str] = None,
resources: Optional[MdbMongodbClusterResourcesArgs] = None,
security_group_ids: Optional[Sequence[str]] = None,
sharded: Optional[bool] = None,
status: Optional[str] = None,
users: Optional[Sequence[MdbMongodbClusterUserArgs]] = None) -> MdbMongodbCluster
func GetMdbMongodbCluster(ctx *Context, name string, id IDInput, state *MdbMongodbClusterState, opts ...ResourceOption) (*MdbMongodbCluster, error)
public static MdbMongodbCluster Get(string name, Input<string> id, MdbMongodbClusterState? state, CustomResourceOptions? opts = null)
public static MdbMongodbCluster get(String name, Output<String> id, MdbMongodbClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- Cluster
Id string - The ID of the cluster.
- Created
At string - Creation timestamp of the key.
- Databases
List<Mdb
Mongodb Cluster Database> - A database of the MongoDB cluster. The structure is documented below.
- Deletion
Protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - Description string
- Description of the MongoDB cluster.
- Environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - Folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- Health string
- The health of the host.
- Hosts
List<Mdb
Mongodb Cluster Host> - A host of the MongoDB cluster. The structure is documented below.
- Labels Dictionary<string, string>
- A set of key/value label pairs to assign to the MongoDB cluster.
- Maintenance
Window MdbMongodb Cluster Maintenance Window - Name string
- The fully qualified domain name of the host. Computed on server side.
- Network
Id string - ID of the network, to which the MongoDB cluster belongs.
- Resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- Security
Group List<string>Ids - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - Users
List<Mdb
Mongodb Cluster User> - A user of the MongoDB cluster. The structure is documented below.
- Cluster
Config MdbMongodb Cluster Cluster Config Args - Configuration of the MongoDB subcluster. The structure is documented below.
- Cluster
Id string - The ID of the cluster.
- Created
At string - Creation timestamp of the key.
- Databases
[]Mdb
Mongodb Cluster Database Args - A database of the MongoDB cluster. The structure is documented below.
- Deletion
Protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - Description string
- Description of the MongoDB cluster.
- Environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - Folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- Health string
- The health of the host.
- Hosts
[]Mdb
Mongodb Cluster Host Args - A host of the MongoDB cluster. The structure is documented below.
- Labels map[string]string
- A set of key/value label pairs to assign to the MongoDB cluster.
- Maintenance
Window MdbMongodb Cluster Maintenance Window Args - Name string
- The fully qualified domain name of the host. Computed on server side.
- Network
Id string - ID of the network, to which the MongoDB cluster belongs.
- Resources
Mdb
Mongodb Cluster Resources Args - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- Security
Group []stringIds - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - Users
[]Mdb
Mongodb Cluster User Args - A user of the MongoDB cluster. The structure is documented below.
- cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- cluster
Id String - The ID of the cluster.
- created
At String - Creation timestamp of the key.
- databases
List<Mdb
Mongodb Cluster Database> - A database of the MongoDB cluster. The structure is documented below.
- deletion
Protection Boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description String
- Description of the MongoDB cluster.
- environment String
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - folder
Id String - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- health String
- The health of the host.
- hosts
List<Mdb
Mongodb Cluster Host> - A host of the MongoDB cluster. The structure is documented below.
- labels Map<String,String>
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window MdbMongodb Cluster Maintenance Window - name String
- The fully qualified domain name of the host. Computed on server side.
- network
Id String - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- security
Group List<String>Ids - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - users
List<Mdb
Mongodb Cluster User> - A user of the MongoDB cluster. The structure is documented below.
- cluster
Config MdbMongodb Cluster Cluster Config - Configuration of the MongoDB subcluster. The structure is documented below.
- cluster
Id string - The ID of the cluster.
- created
At string - Creation timestamp of the key.
- databases
Mdb
Mongodb Cluster Database[] - A database of the MongoDB cluster. The structure is documented below.
- deletion
Protection boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description string
- Description of the MongoDB cluster.
- environment string
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - folder
Id string - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- health string
- The health of the host.
- hosts
Mdb
Mongodb Cluster Host[] - A host of the MongoDB cluster. The structure is documented below.
- labels {[key: string]: string}
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window MdbMongodb Cluster Maintenance Window - name string
- The fully qualified domain name of the host. Computed on server side.
- network
Id string - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- security
Group string[]Ids - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - users
Mdb
Mongodb Cluster User[] - A user of the MongoDB cluster. The structure is documented below.
- cluster_
config MdbMongodb Cluster Cluster Config Args - Configuration of the MongoDB subcluster. The structure is documented below.
- cluster_
id str - The ID of the cluster.
- created_
at str - Creation timestamp of the key.
- databases
Sequence[Mdb
Mongodb Cluster Database Args] - A database of the MongoDB cluster. The structure is documented below.
- deletion_
protection bool - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description str
- Description of the MongoDB cluster.
- environment str
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - folder_
id str - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- health str
- The health of the host.
- hosts
Sequence[Mdb
Mongodb Cluster Host Args] - A host of the MongoDB cluster. The structure is documented below.
- labels Mapping[str, str]
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance_
window MdbMongodb Cluster Maintenance Window Args - name str
- The fully qualified domain name of the host. Computed on server side.
- network_
id str - ID of the network, to which the MongoDB cluster belongs.
- resources
Mdb
Mongodb Cluster Resources Args - Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- security_
group_ Sequence[str]ids - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - users
Sequence[Mdb
Mongodb Cluster User Args] - A user of the MongoDB cluster. The structure is documented below.
- cluster
Config Property Map - Configuration of the MongoDB subcluster. The structure is documented below.
- cluster
Id String - The ID of the cluster.
- created
At String - Creation timestamp of the key.
- databases List<Property Map>
- A database of the MongoDB cluster. The structure is documented below.
- deletion
Protection Boolean - Inhibits deletion of the cluster. Can be either
true
orfalse
. - description String
- Description of the MongoDB cluster.
- environment String
- Deployment environment of the MongoDB cluster. Can be either
PRESTABLE
orPRODUCTION
. - folder
Id String - The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
- health String
- The health of the host.
- hosts List<Property Map>
- A host of the MongoDB cluster. The structure is documented below.
- labels Map<String>
- A set of key/value label pairs to assign to the MongoDB cluster.
- maintenance
Window Property Map - name String
- The fully qualified domain name of the host. Computed on server side.
- network
Id String - ID of the network, to which the MongoDB cluster belongs.
- resources Property Map
- Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
- security
Group List<String>Ids - 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. Can be either
CREATING
,STARTING
,RUNNING
,UPDATING
,STOPPING
,STOPPED
,ERROR
orSTATUS_UNKNOWN
. For more information seestatus
field of JSON representation in the official documentation. - users List<Property Map>
- A user of the MongoDB cluster. The structure is documented below.
Supporting Types
MdbMongodbClusterClusterConfig, MdbMongodbClusterClusterConfigArgs
- Version string
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- Access
Mdb
Mongodb Cluster Cluster Config Access - Shows whether cluster has access to data lens. The structure is documented below.
- Backup
Window MdbStart Mongodb Cluster Cluster Config Backup Window Start - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- Feature
Compatibility stringVersion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
- Version string
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- Access
Mdb
Mongodb Cluster Cluster Config Access - Shows whether cluster has access to data lens. The structure is documented below.
- Backup
Window MdbStart Mongodb Cluster Cluster Config Backup Window Start - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- Feature
Compatibility stringVersion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
- version String
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- access
Mdb
Mongodb Cluster Cluster Config Access - Shows whether cluster has access to data lens. The structure is documented below.
- backup
Window MdbStart Mongodb Cluster Cluster Config Backup Window Start - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- feature
Compatibility StringVersion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
- version string
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- access
Mdb
Mongodb Cluster Cluster Config Access - Shows whether cluster has access to data lens. The structure is documented below.
- backup
Window MdbStart Mongodb Cluster Cluster Config Backup Window Start - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- feature
Compatibility stringVersion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
- version str
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- access
Mdb
Mongodb Cluster Cluster Config Access - Shows whether cluster has access to data lens. The structure is documented below.
- backup_
window_ Mdbstart Mongodb Cluster Cluster Config Backup Window Start - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- feature_
compatibility_ strversion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
- version String
- Version of MongoDB (either 5.0, 4.4, 4.2 or 4.0).
- access Property Map
- Shows whether cluster has access to data lens. The structure is documented below.
- backup
Window Property MapStart - Time to start the daily backup, in the UTC timezone. The structure is documented below.
- feature
Compatibility StringVersion - Feature compatibility version of MongoDB. If not provided version is taken. Can be either
5.0
,4.4
,4.2
and4.0
.
MdbMongodbClusterClusterConfigAccess, MdbMongodbClusterClusterConfigAccessArgs
- Data
Lens bool - Allow access for DataLens.
- Data
Lens bool - Allow access for DataLens.
- data
Lens Boolean - Allow access for DataLens.
- data
Lens boolean - Allow access for DataLens.
- data_
lens bool - Allow access for DataLens.
- data
Lens Boolean - Allow access for DataLens.
MdbMongodbClusterClusterConfigBackupWindowStart, MdbMongodbClusterClusterConfigBackupWindowStartArgs
MdbMongodbClusterDatabase, MdbMongodbClusterDatabaseArgs
- Name string
- The fully qualified domain name of the host. Computed on server side.
- Name string
- The fully qualified domain name of the host. Computed on server side.
- name String
- The fully qualified domain name of the host. Computed on server side.
- name string
- The fully qualified domain name of the host. Computed on server side.
- name str
- The fully qualified domain name of the host. Computed on server side.
- name String
- The fully qualified domain name of the host. Computed on server side.
MdbMongodbClusterHost, MdbMongodbClusterHostArgs
- Subnet
Id 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.
- Zone
Id string - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- Assign
Public boolIp - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - Health string
- The health of the host.
- Name string
- The fully qualified domain name of the host. Computed on server side.
- Role string
- The role of the cluster (either PRIMARY or SECONDARY).
- string
- The name of the shard to which the host belongs.
- Type string
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
- Subnet
Id 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.
- Zone
Id string - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- Assign
Public boolIp - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - Health string
- The health of the host.
- Name string
- The fully qualified domain name of the host. Computed on server side.
- Role string
- The role of the cluster (either PRIMARY or SECONDARY).
- string
- The name of the shard to which the host belongs.
- Type string
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
- subnet
Id 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.
- zone
Id String - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- assign
Public BooleanIp - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - health String
- The health of the host.
- name String
- The fully qualified domain name of the host. Computed on server side.
- role String
- The role of the cluster (either PRIMARY or SECONDARY).
- String
- The name of the shard to which the host belongs.
- type String
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
- subnet
Id 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.
- zone
Id string - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- assign
Public booleanIp - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - health string
- The health of the host.
- name string
- The fully qualified domain name of the host. Computed on server side.
- role string
- The role of the cluster (either PRIMARY or SECONDARY).
- string
- The name of the shard to which the host belongs.
- type string
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
- 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.
- zone_
id str - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- assign_
public_ boolip - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - health str
- The health of the host.
- name str
- The fully qualified domain name of the host. Computed on server side.
- role str
- The role of the cluster (either PRIMARY or SECONDARY).
- str
- The name of the shard to which the host belongs.
- type str
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
- subnet
Id 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.
- zone
Id String - The availability zone where the MongoDB host will be created. For more information see the official documentation.
- assign
Public BooleanIp - -(Optional) Should this host have assigned public IP assigned. Can be either
true
orfalse
. - health String
- The health of the host.
- name String
- The fully qualified domain name of the host. Computed on server side.
- role String
- The role of the cluster (either PRIMARY or SECONDARY).
- String
- The name of the shard to which the host belongs.
- type String
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. A day and hour of window need to be specified with weekly window.
MdbMongodbClusterMaintenanceWindow, MdbMongodbClusterMaintenanceWindowArgs
- Type string
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. 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
orWEEKLY
. 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
orWEEKLY
. 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
orWEEKLY
. 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 str
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. 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 String
- Type of maintenance window. Can be either
ANYTIME
orWEEKLY
. 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.
MdbMongodbClusterResources, MdbMongodbClusterResourcesArgs
- Disk
Size int - Volume of the storage available to a MongoDB host, in gigabytes.
- Disk
Type stringId - Type of the storage of MongoDB hosts. For more information see the official documentation.
- Resource
Preset stringId
- Disk
Size int - Volume of the storage available to a MongoDB host, in gigabytes.
- Disk
Type stringId - Type of the storage of MongoDB hosts. For more information see the official documentation.
- Resource
Preset stringId
- disk
Size Integer - Volume of the storage available to a MongoDB host, in gigabytes.
- disk
Type StringId - Type of the storage of MongoDB hosts. For more information see the official documentation.
- resource
Preset StringId
- disk
Size number - Volume of the storage available to a MongoDB host, in gigabytes.
- disk
Type stringId - Type of the storage of MongoDB hosts. For more information see the official documentation.
- resource
Preset stringId
- disk_
size int - Volume of the storage available to a MongoDB host, in gigabytes.
- disk_
type_ strid - Type of the storage of MongoDB hosts. For more information see the official documentation.
- resource_
preset_ strid
- disk
Size Number - Volume of the storage available to a MongoDB host, in gigabytes.
- disk
Type StringId - Type of the storage of MongoDB hosts. For more information see the official documentation.
- resource
Preset StringId
MdbMongodbClusterUser, MdbMongodbClusterUserArgs
- Name string
- The fully qualified domain name of the host. Computed on server side.
- Password string
- The password of the user.
- Permissions
List<Mdb
Mongodb Cluster User Permission> - Set of permissions granted to the user. The structure is documented below.
- Name string
- The fully qualified domain name of the host. Computed on server side.
- Password string
- The password of the user.
- Permissions
[]Mdb
Mongodb Cluster User Permission - Set of permissions granted to the user. The structure is documented below.
- name String
- The fully qualified domain name of the host. Computed on server side.
- password String
- The password of the user.
- permissions
List<Mdb
Mongodb Cluster User Permission> - Set of permissions granted to the user. The structure is documented below.
- name string
- The fully qualified domain name of the host. Computed on server side.
- password string
- The password of the user.
- permissions
Mdb
Mongodb Cluster User Permission[] - Set of permissions granted to the user. The structure is documented below.
- name str
- The fully qualified domain name of the host. Computed on server side.
- password str
- The password of the user.
- permissions
Sequence[Mdb
Mongodb Cluster User Permission] - Set of permissions granted to the user. The structure is documented below.
- name String
- The fully qualified domain name of the host. Computed on server side.
- password String
- The password of the user.
- permissions List<Property Map>
- Set of permissions granted to the user. The structure is documented below.
MdbMongodbClusterUserPermission, MdbMongodbClusterUserPermissionArgs
- Database
Name string - The name of the database that the permission grants access to.
- Roles List<string>
- The roles of the user in this database. For more information see the official documentation.
- Database
Name string - The name of the database that the permission grants access to.
- Roles []string
- The roles of the user in this database. For more information see the official documentation.
- database
Name String - The name of the database that the permission grants access to.
- roles List<String>
- The roles of the user in this database. For more information see the official documentation.
- database
Name string - The name of the database that the permission grants access to.
- roles string[]
- 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]
- The roles of the user in this database. For more information see the official documentation.
- database
Name String - The name of the database that the permission grants access to.
- roles List<String>
- The roles of the user in this database. For more information see the official documentation.
Import
A cluster can be imported using the id
of the resource, e.g.
$ pulumi import yandex:index/mdbMongodbCluster:MdbMongodbCluster foo cluster_id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Yandex pulumi/pulumi-yandex
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
yandex
Terraform Provider.