azure-native.mongocluster.MongoCluster
Explore with Pulumi AI
Represents a mongo cluster resource.
Uses Azure REST API version 2024-07-01.
Other available API versions: 2024-03-01-preview, 2024-06-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native mongocluster [ApiVersion]
. See the version guide for details.
Example Usage
Creates a Mongo Cluster resource from a point in time restore
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var mongoCluster = new AzureNative.MongoCluster.MongoCluster("mongoCluster", new()
{
Location = "westus2",
MongoClusterName = "myMongoCluster",
Properties = new AzureNative.MongoCluster.Inputs.MongoClusterPropertiesArgs
{
CreateMode = AzureNative.MongoCluster.CreateMode.PointInTimeRestore,
RestoreParameters = new AzureNative.MongoCluster.Inputs.MongoClusterRestoreParametersArgs
{
PointInTimeUTC = "2023-01-13T20:07:35Z",
SourceResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
},
},
ResourceGroupName = "TestResourceGroup",
});
});
package main
import (
mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongocluster.NewMongoCluster(ctx, "mongoCluster", &mongocluster.MongoClusterArgs{
Location: pulumi.String("westus2"),
MongoClusterName: pulumi.String("myMongoCluster"),
Properties: &mongocluster.MongoClusterPropertiesArgs{
CreateMode: pulumi.String(mongocluster.CreateModePointInTimeRestore),
RestoreParameters: &mongocluster.MongoClusterRestoreParametersArgs{
PointInTimeUTC: pulumi.String("2023-01-13T20:07:35Z"),
SourceResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster"),
},
},
ResourceGroupName: pulumi.String("TestResourceGroup"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.mongocluster.MongoCluster;
import com.pulumi.azurenative.mongocluster.MongoClusterArgs;
import com.pulumi.azurenative.mongocluster.inputs.MongoClusterPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.MongoClusterRestoreParametersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var mongoCluster = new MongoCluster("mongoCluster", MongoClusterArgs.builder()
.location("westus2")
.mongoClusterName("myMongoCluster")
.properties(MongoClusterPropertiesArgs.builder()
.createMode("PointInTimeRestore")
.restoreParameters(MongoClusterRestoreParametersArgs.builder()
.pointInTimeUTC("2023-01-13T20:07:35Z")
.sourceResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster")
.build())
.build())
.resourceGroupName("TestResourceGroup")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const mongoCluster = new azure_native.mongocluster.MongoCluster("mongoCluster", {
location: "westus2",
mongoClusterName: "myMongoCluster",
properties: {
createMode: azure_native.mongocluster.CreateMode.PointInTimeRestore,
restoreParameters: {
pointInTimeUTC: "2023-01-13T20:07:35Z",
sourceResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
},
},
resourceGroupName: "TestResourceGroup",
});
import pulumi
import pulumi_azure_native as azure_native
mongo_cluster = azure_native.mongocluster.MongoCluster("mongoCluster",
location="westus2",
mongo_cluster_name="myMongoCluster",
properties={
"create_mode": azure_native.mongocluster.CreateMode.POINT_IN_TIME_RESTORE,
"restore_parameters": {
"point_in_time_utc": "2023-01-13T20:07:35Z",
"source_resource_id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
},
},
resource_group_name="TestResourceGroup")
resources:
mongoCluster:
type: azure-native:mongocluster:MongoCluster
properties:
location: westus2
mongoClusterName: myMongoCluster
properties:
createMode: PointInTimeRestore
restoreParameters:
pointInTimeUTC: 2023-01-13T20:07:35Z
sourceResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster
resourceGroupName: TestResourceGroup
Creates a new Mongo Cluster resource.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var mongoCluster = new AzureNative.MongoCluster.MongoCluster("mongoCluster", new()
{
Location = "westus2",
MongoClusterName = "myMongoCluster",
Properties = new AzureNative.MongoCluster.Inputs.MongoClusterPropertiesArgs
{
Administrator = new AzureNative.MongoCluster.Inputs.AdministratorPropertiesArgs
{
Password = "password",
UserName = "mongoAdmin",
},
Compute = new AzureNative.MongoCluster.Inputs.ComputePropertiesArgs
{
Tier = "M30",
},
HighAvailability = new AzureNative.MongoCluster.Inputs.HighAvailabilityPropertiesArgs
{
TargetMode = AzureNative.MongoCluster.HighAvailabilityMode.SameZone,
},
ServerVersion = "5.0",
Sharding = new AzureNative.MongoCluster.Inputs.ShardingPropertiesArgs
{
ShardCount = 1,
},
Storage = new AzureNative.MongoCluster.Inputs.StoragePropertiesArgs
{
SizeGb = 128,
},
},
ResourceGroupName = "TestResourceGroup",
});
});
package main
import (
mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongocluster.NewMongoCluster(ctx, "mongoCluster", &mongocluster.MongoClusterArgs{
Location: pulumi.String("westus2"),
MongoClusterName: pulumi.String("myMongoCluster"),
Properties: &mongocluster.MongoClusterPropertiesArgs{
Administrator: &mongocluster.AdministratorPropertiesArgs{
Password: pulumi.String("password"),
UserName: pulumi.String("mongoAdmin"),
},
Compute: &mongocluster.ComputePropertiesArgs{
Tier: pulumi.String("M30"),
},
HighAvailability: &mongocluster.HighAvailabilityPropertiesArgs{
TargetMode: pulumi.String(mongocluster.HighAvailabilityModeSameZone),
},
ServerVersion: pulumi.String("5.0"),
Sharding: &mongocluster.ShardingPropertiesArgs{
ShardCount: pulumi.Int(1),
},
Storage: &mongocluster.StoragePropertiesArgs{
SizeGb: pulumi.Float64(128),
},
},
ResourceGroupName: pulumi.String("TestResourceGroup"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.mongocluster.MongoCluster;
import com.pulumi.azurenative.mongocluster.MongoClusterArgs;
import com.pulumi.azurenative.mongocluster.inputs.MongoClusterPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.AdministratorPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.ComputePropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.HighAvailabilityPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.ShardingPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.StoragePropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var mongoCluster = new MongoCluster("mongoCluster", MongoClusterArgs.builder()
.location("westus2")
.mongoClusterName("myMongoCluster")
.properties(MongoClusterPropertiesArgs.builder()
.administrator(AdministratorPropertiesArgs.builder()
.password("password")
.userName("mongoAdmin")
.build())
.compute(ComputePropertiesArgs.builder()
.tier("M30")
.build())
.highAvailability(HighAvailabilityPropertiesArgs.builder()
.targetMode("SameZone")
.build())
.serverVersion("5.0")
.sharding(ShardingPropertiesArgs.builder()
.shardCount(1)
.build())
.storage(StoragePropertiesArgs.builder()
.sizeGb(128.0)
.build())
.build())
.resourceGroupName("TestResourceGroup")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const mongoCluster = new azure_native.mongocluster.MongoCluster("mongoCluster", {
location: "westus2",
mongoClusterName: "myMongoCluster",
properties: {
administrator: {
password: "password",
userName: "mongoAdmin",
},
compute: {
tier: "M30",
},
highAvailability: {
targetMode: azure_native.mongocluster.HighAvailabilityMode.SameZone,
},
serverVersion: "5.0",
sharding: {
shardCount: 1,
},
storage: {
sizeGb: 128,
},
},
resourceGroupName: "TestResourceGroup",
});
import pulumi
import pulumi_azure_native as azure_native
mongo_cluster = azure_native.mongocluster.MongoCluster("mongoCluster",
location="westus2",
mongo_cluster_name="myMongoCluster",
properties={
"administrator": {
"password": "password",
"user_name": "mongoAdmin",
},
"compute": {
"tier": "M30",
},
"high_availability": {
"target_mode": azure_native.mongocluster.HighAvailabilityMode.SAME_ZONE,
},
"server_version": "5.0",
"sharding": {
"shard_count": 1,
},
"storage": {
"size_gb": 128,
},
},
resource_group_name="TestResourceGroup")
resources:
mongoCluster:
type: azure-native:mongocluster:MongoCluster
properties:
location: westus2
mongoClusterName: myMongoCluster
properties:
administrator:
password: password
userName: mongoAdmin
compute:
tier: M30
highAvailability:
targetMode: SameZone
serverVersion: '5.0'
sharding:
shardCount: 1
storage:
sizeGb: 128
resourceGroupName: TestResourceGroup
Creates a replica Mongo Cluster resource from a source resource.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var mongoCluster = new AzureNative.MongoCluster.MongoCluster("mongoCluster", new()
{
Location = "centralus",
MongoClusterName = "myReplicaMongoCluster",
Properties = new AzureNative.MongoCluster.Inputs.MongoClusterPropertiesArgs
{
CreateMode = AzureNative.MongoCluster.CreateMode.GeoReplica,
ReplicaParameters = new AzureNative.MongoCluster.Inputs.MongoClusterReplicaParametersArgs
{
SourceLocation = "eastus",
SourceResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster",
},
},
ResourceGroupName = "TestResourceGroup",
});
});
package main
import (
mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongocluster.NewMongoCluster(ctx, "mongoCluster", &mongocluster.MongoClusterArgs{
Location: pulumi.String("centralus"),
MongoClusterName: pulumi.String("myReplicaMongoCluster"),
Properties: &mongocluster.MongoClusterPropertiesArgs{
CreateMode: pulumi.String(mongocluster.CreateModeGeoReplica),
ReplicaParameters: &mongocluster.MongoClusterReplicaParametersArgs{
SourceLocation: pulumi.String("eastus"),
SourceResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster"),
},
},
ResourceGroupName: pulumi.String("TestResourceGroup"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.mongocluster.MongoCluster;
import com.pulumi.azurenative.mongocluster.MongoClusterArgs;
import com.pulumi.azurenative.mongocluster.inputs.MongoClusterPropertiesArgs;
import com.pulumi.azurenative.mongocluster.inputs.MongoClusterReplicaParametersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var mongoCluster = new MongoCluster("mongoCluster", MongoClusterArgs.builder()
.location("centralus")
.mongoClusterName("myReplicaMongoCluster")
.properties(MongoClusterPropertiesArgs.builder()
.createMode("GeoReplica")
.replicaParameters(MongoClusterReplicaParametersArgs.builder()
.sourceLocation("eastus")
.sourceResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster")
.build())
.build())
.resourceGroupName("TestResourceGroup")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const mongoCluster = new azure_native.mongocluster.MongoCluster("mongoCluster", {
location: "centralus",
mongoClusterName: "myReplicaMongoCluster",
properties: {
createMode: azure_native.mongocluster.CreateMode.GeoReplica,
replicaParameters: {
sourceLocation: "eastus",
sourceResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster",
},
},
resourceGroupName: "TestResourceGroup",
});
import pulumi
import pulumi_azure_native as azure_native
mongo_cluster = azure_native.mongocluster.MongoCluster("mongoCluster",
location="centralus",
mongo_cluster_name="myReplicaMongoCluster",
properties={
"create_mode": azure_native.mongocluster.CreateMode.GEO_REPLICA,
"replica_parameters": {
"source_location": "eastus",
"source_resource_id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster",
},
},
resource_group_name="TestResourceGroup")
resources:
mongoCluster:
type: azure-native:mongocluster:MongoCluster
properties:
location: centralus
mongoClusterName: myReplicaMongoCluster
properties:
createMode: GeoReplica
replicaParameters:
sourceLocation: eastus
sourceResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/mySourceMongoCluster
resourceGroupName: TestResourceGroup
Create MongoCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MongoCluster(name: string, args: MongoClusterArgs, opts?: CustomResourceOptions);
@overload
def MongoCluster(resource_name: str,
args: MongoClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MongoCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
mongo_cluster_name: Optional[str] = None,
properties: Optional[MongoClusterPropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewMongoCluster(ctx *Context, name string, args MongoClusterArgs, opts ...ResourceOption) (*MongoCluster, error)
public MongoCluster(string name, MongoClusterArgs args, CustomResourceOptions? opts = null)
public MongoCluster(String name, MongoClusterArgs args)
public MongoCluster(String name, MongoClusterArgs args, CustomResourceOptions options)
type: azure-native:mongocluster:MongoCluster
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 MongoClusterArgs
- 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 MongoClusterArgs
- 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 MongoClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MongoClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MongoClusterArgs
- 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 azure_nativeMongoClusterResource = new AzureNative.MongoCluster.MongoCluster("azure-nativeMongoClusterResource", new()
{
ResourceGroupName = "string",
Location = "string",
MongoClusterName = "string",
Properties = new AzureNative.MongoCluster.Inputs.MongoClusterPropertiesArgs
{
Administrator = new AzureNative.MongoCluster.Inputs.AdministratorPropertiesArgs
{
Password = "string",
UserName = "string",
},
Compute = new AzureNative.MongoCluster.Inputs.ComputePropertiesArgs
{
Tier = "string",
},
CreateMode = "string",
HighAvailability = new AzureNative.MongoCluster.Inputs.HighAvailabilityPropertiesArgs
{
TargetMode = "string",
},
PreviewFeatures = new[]
{
"string",
},
PublicNetworkAccess = "string",
ReplicaParameters = new AzureNative.MongoCluster.Inputs.MongoClusterReplicaParametersArgs
{
SourceLocation = "string",
SourceResourceId = "string",
},
RestoreParameters = new AzureNative.MongoCluster.Inputs.MongoClusterRestoreParametersArgs
{
PointInTimeUTC = "string",
SourceResourceId = "string",
},
ServerVersion = "string",
Sharding = new AzureNative.MongoCluster.Inputs.ShardingPropertiesArgs
{
ShardCount = 0,
},
Storage = new AzureNative.MongoCluster.Inputs.StoragePropertiesArgs
{
SizeGb = 0,
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := mongocluster.NewMongoCluster(ctx, "azure-nativeMongoClusterResource", &mongocluster.MongoClusterArgs{
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
MongoClusterName: pulumi.String("string"),
Properties: &mongocluster.MongoClusterPropertiesArgs{
Administrator: &mongocluster.AdministratorPropertiesArgs{
Password: pulumi.String("string"),
UserName: pulumi.String("string"),
},
Compute: &mongocluster.ComputePropertiesArgs{
Tier: pulumi.String("string"),
},
CreateMode: pulumi.String("string"),
HighAvailability: &mongocluster.HighAvailabilityPropertiesArgs{
TargetMode: pulumi.String("string"),
},
PreviewFeatures: pulumi.StringArray{
pulumi.String("string"),
},
PublicNetworkAccess: pulumi.String("string"),
ReplicaParameters: &mongocluster.MongoClusterReplicaParametersArgs{
SourceLocation: pulumi.String("string"),
SourceResourceId: pulumi.String("string"),
},
RestoreParameters: &mongocluster.MongoClusterRestoreParametersArgs{
PointInTimeUTC: pulumi.String("string"),
SourceResourceId: pulumi.String("string"),
},
ServerVersion: pulumi.String("string"),
Sharding: &mongocluster.ShardingPropertiesArgs{
ShardCount: pulumi.Int(0),
},
Storage: &mongocluster.StoragePropertiesArgs{
SizeGb: pulumi.Float64(0),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var azure_nativeMongoClusterResource = new com.pulumi.azurenative.mongocluster.MongoCluster("azure-nativeMongoClusterResource", com.pulumi.azurenative.mongocluster.MongoClusterArgs.builder()
.resourceGroupName("string")
.location("string")
.mongoClusterName("string")
.properties(MongoClusterPropertiesArgs.builder()
.administrator(AdministratorPropertiesArgs.builder()
.password("string")
.userName("string")
.build())
.compute(ComputePropertiesArgs.builder()
.tier("string")
.build())
.createMode("string")
.highAvailability(HighAvailabilityPropertiesArgs.builder()
.targetMode("string")
.build())
.previewFeatures("string")
.publicNetworkAccess("string")
.replicaParameters(MongoClusterReplicaParametersArgs.builder()
.sourceLocation("string")
.sourceResourceId("string")
.build())
.restoreParameters(MongoClusterRestoreParametersArgs.builder()
.pointInTimeUTC("string")
.sourceResourceId("string")
.build())
.serverVersion("string")
.sharding(ShardingPropertiesArgs.builder()
.shardCount(0)
.build())
.storage(StoragePropertiesArgs.builder()
.sizeGb(0)
.build())
.build())
.tags(Map.of("string", "string"))
.build());
azure_native_mongo_cluster_resource = azure_native.mongocluster.MongoCluster("azure-nativeMongoClusterResource",
resource_group_name="string",
location="string",
mongo_cluster_name="string",
properties={
"administrator": {
"password": "string",
"user_name": "string",
},
"compute": {
"tier": "string",
},
"create_mode": "string",
"high_availability": {
"target_mode": "string",
},
"preview_features": ["string"],
"public_network_access": "string",
"replica_parameters": {
"source_location": "string",
"source_resource_id": "string",
},
"restore_parameters": {
"point_in_time_utc": "string",
"source_resource_id": "string",
},
"server_version": "string",
"sharding": {
"shard_count": 0,
},
"storage": {
"size_gb": 0,
},
},
tags={
"string": "string",
})
const azure_nativeMongoClusterResource = new azure_native.mongocluster.MongoCluster("azure-nativeMongoClusterResource", {
resourceGroupName: "string",
location: "string",
mongoClusterName: "string",
properties: {
administrator: {
password: "string",
userName: "string",
},
compute: {
tier: "string",
},
createMode: "string",
highAvailability: {
targetMode: "string",
},
previewFeatures: ["string"],
publicNetworkAccess: "string",
replicaParameters: {
sourceLocation: "string",
sourceResourceId: "string",
},
restoreParameters: {
pointInTimeUTC: "string",
sourceResourceId: "string",
},
serverVersion: "string",
sharding: {
shardCount: 0,
},
storage: {
sizeGb: 0,
},
},
tags: {
string: "string",
},
});
type: azure-native:mongocluster:MongoCluster
properties:
location: string
mongoClusterName: string
properties:
administrator:
password: string
userName: string
compute:
tier: string
createMode: string
highAvailability:
targetMode: string
previewFeatures:
- string
publicNetworkAccess: string
replicaParameters:
sourceLocation: string
sourceResourceId: string
restoreParameters:
pointInTimeUTC: string
sourceResourceId: string
serverVersion: string
sharding:
shardCount: 0
storage:
sizeGb: 0
resourceGroupName: string
tags:
string: string
MongoCluster 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 MongoCluster resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Mongo
Cluster stringName - The name of the mongo cluster.
- Properties
Pulumi.
Azure Native. Mongo Cluster. Inputs. Mongo Cluster Properties - The resource-specific properties for this resource.
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Mongo
Cluster stringName - The name of the mongo cluster.
- Properties
Mongo
Cluster Properties Args - The resource-specific properties for this resource.
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- mongo
Cluster StringName - The name of the mongo cluster.
- properties
Mongo
Cluster Properties - The resource-specific properties for this resource.
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- location string
- The geo-location where the resource lives
- mongo
Cluster stringName - The name of the mongo cluster.
- properties
Mongo
Cluster Properties - The resource-specific properties for this resource.
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- location str
- The geo-location where the resource lives
- mongo_
cluster_ strname - The name of the mongo cluster.
- properties
Mongo
Cluster Properties Args - The resource-specific properties for this resource.
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- mongo
Cluster StringName - The name of the mongo cluster.
- properties Property Map
- The resource-specific properties for this resource.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the MongoCluster resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Mongo Cluster. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AdministratorProperties, AdministratorPropertiesArgs
AdministratorPropertiesResponse, AdministratorPropertiesResponseArgs
- User
Name string - The administrator user name.
- User
Name string - The administrator user name.
- user
Name String - The administrator user name.
- user
Name string - The administrator user name.
- user_
name str - The administrator user name.
- user
Name String - The administrator user name.
BackupPropertiesResponse, BackupPropertiesResponseArgs
- Earliest
Restore stringTime - Earliest restore timestamp in UTC ISO8601 format.
- Earliest
Restore stringTime - Earliest restore timestamp in UTC ISO8601 format.
- earliest
Restore StringTime - Earliest restore timestamp in UTC ISO8601 format.
- earliest
Restore stringTime - Earliest restore timestamp in UTC ISO8601 format.
- earliest_
restore_ strtime - Earliest restore timestamp in UTC ISO8601 format.
- earliest
Restore StringTime - Earliest restore timestamp in UTC ISO8601 format.
ComputeProperties, ComputePropertiesArgs
- Tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- Tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier String
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier str
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier String
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
ComputePropertiesResponse, ComputePropertiesResponseArgs
- Tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- Tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier String
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier string
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier str
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- tier String
- The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
CreateMode, CreateModeArgs
- Default
- DefaultCreate a new mongo cluster.
- Point
In Time Restore - PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- Geo
Replica - GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- Replica
- ReplicaCreate a replica cluster in the same geographic region as the source cluster.
- Create
Mode Default - DefaultCreate a new mongo cluster.
- Create
Mode Point In Time Restore - PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- Create
Mode Geo Replica - GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- Create
Mode Replica - ReplicaCreate a replica cluster in the same geographic region as the source cluster.
- Default
- DefaultCreate a new mongo cluster.
- Point
In Time Restore - PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- Geo
Replica - GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- Replica
- ReplicaCreate a replica cluster in the same geographic region as the source cluster.
- Default
- DefaultCreate a new mongo cluster.
- Point
In Time Restore - PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- Geo
Replica - GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- Replica
- ReplicaCreate a replica cluster in the same geographic region as the source cluster.
- DEFAULT
- DefaultCreate a new mongo cluster.
- POINT_IN_TIME_RESTORE
- PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- GEO_REPLICA
- GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- REPLICA
- ReplicaCreate a replica cluster in the same geographic region as the source cluster.
- "Default"
- DefaultCreate a new mongo cluster.
- "Point
In Time Restore" - PointInTimeRestoreCreate a mongo cluster from a restore point-in-time.
- "Geo
Replica" - GeoReplicaCreate a replica cluster in distinct geographic region from the source cluster.
- "Replica"
- ReplicaCreate a replica cluster in the same geographic region as the source cluster.
HighAvailabilityMode, HighAvailabilityModeArgs
- Disabled
- DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- Same
Zone - SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- Zone
Redundant Preferred - ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
- High
Availability Mode Disabled - DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- High
Availability Mode Same Zone - SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- High
Availability Mode Zone Redundant Preferred - ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
- Disabled
- DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- Same
Zone - SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- Zone
Redundant Preferred - ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
- Disabled
- DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- Same
Zone - SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- Zone
Redundant Preferred - ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
- DISABLED
- DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- SAME_ZONE
- SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- ZONE_REDUNDANT_PREFERRED
- ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
- "Disabled"
- DisabledHigh availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
- "Same
Zone" - SameZoneHigh availability mode is enabled, where each server in a shard is placed in the same availability zone.
- "Zone
Redundant Preferred" - ZoneRedundantPreferredHigh availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.
HighAvailabilityProperties, HighAvailabilityPropertiesArgs
- Target
Mode string | Pulumi.Azure Native. Mongo Cluster. High Availability Mode - The target high availability mode requested for the cluster.
- Target
Mode string | HighAvailability Mode - The target high availability mode requested for the cluster.
- target
Mode String | HighAvailability Mode - The target high availability mode requested for the cluster.
- target
Mode string | HighAvailability Mode - The target high availability mode requested for the cluster.
- target_
mode str | HighAvailability Mode - The target high availability mode requested for the cluster.
- target
Mode String | "Disabled" | "SameZone" | "Zone Redundant Preferred" - The target high availability mode requested for the cluster.
HighAvailabilityPropertiesResponse, HighAvailabilityPropertiesResponseArgs
- Target
Mode string - The target high availability mode requested for the cluster.
- Target
Mode string - The target high availability mode requested for the cluster.
- target
Mode String - The target high availability mode requested for the cluster.
- target
Mode string - The target high availability mode requested for the cluster.
- target_
mode str - The target high availability mode requested for the cluster.
- target
Mode String - The target high availability mode requested for the cluster.
MongoClusterProperties, MongoClusterPropertiesArgs
- Administrator
Pulumi.
Azure Native. Mongo Cluster. Inputs. Administrator Properties - The local administrator properties for the mongo cluster.
- Compute
Pulumi.
Azure Native. Mongo Cluster. Inputs. Compute Properties - The compute properties of the mongo cluster.
- Create
Mode string | Pulumi.Azure Native. Mongo Cluster. Create Mode - The mode to create a mongo cluster.
- High
Availability Pulumi.Azure Native. Mongo Cluster. Inputs. High Availability Properties - The high availability properties of the mongo cluster.
- Preview
Features List<Union<string, Pulumi.Azure Native. Mongo Cluster. Preview Feature>> - List of private endpoint connections.
- Public
Network string | Pulumi.Access Azure Native. Mongo Cluster. Public Network Access - Whether or not public endpoint access is allowed for this mongo cluster.
- Replica
Parameters Pulumi.Azure Native. Mongo Cluster. Inputs. Mongo Cluster Replica Parameters - The parameters to create a replica mongo cluster.
- Restore
Parameters Pulumi.Azure Native. Mongo Cluster. Inputs. Mongo Cluster Restore Parameters - The parameters to create a point-in-time restore mongo cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Pulumi.
Azure Native. Mongo Cluster. Inputs. Sharding Properties - The sharding properties of the mongo cluster.
- Storage
Pulumi.
Azure Native. Mongo Cluster. Inputs. Storage Properties - The storage properties of the mongo cluster.
- Administrator
Administrator
Properties - The local administrator properties for the mongo cluster.
- Compute
Compute
Properties - The compute properties of the mongo cluster.
- Create
Mode string | CreateMode - The mode to create a mongo cluster.
- High
Availability HighAvailability Properties - The high availability properties of the mongo cluster.
- Preview
Features []string - List of private endpoint connections.
- Public
Network string | PublicAccess Network Access - Whether or not public endpoint access is allowed for this mongo cluster.
- Replica
Parameters MongoCluster Replica Parameters - The parameters to create a replica mongo cluster.
- Restore
Parameters MongoCluster Restore Parameters - The parameters to create a point-in-time restore mongo cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties - The sharding properties of the mongo cluster.
- Storage
Storage
Properties - The storage properties of the mongo cluster.
- administrator
Administrator
Properties - The local administrator properties for the mongo cluster.
- compute
Compute
Properties - The compute properties of the mongo cluster.
- create
Mode String | CreateMode - The mode to create a mongo cluster.
- high
Availability HighAvailability Properties - The high availability properties of the mongo cluster.
- preview
Features List<Either<String,PreviewFeature>> - List of private endpoint connections.
- public
Network String | PublicAccess Network Access - Whether or not public endpoint access is allowed for this mongo cluster.
- replica
Parameters MongoCluster Replica Parameters - The parameters to create a replica mongo cluster.
- restore
Parameters MongoCluster Restore Parameters - The parameters to create a point-in-time restore mongo cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties - The sharding properties of the mongo cluster.
- storage
Storage
Properties - The storage properties of the mongo cluster.
- administrator
Administrator
Properties - The local administrator properties for the mongo cluster.
- compute
Compute
Properties - The compute properties of the mongo cluster.
- create
Mode string | CreateMode - The mode to create a mongo cluster.
- high
Availability HighAvailability Properties - The high availability properties of the mongo cluster.
- preview
Features (string | PreviewFeature)[] - List of private endpoint connections.
- public
Network string | PublicAccess Network Access - Whether or not public endpoint access is allowed for this mongo cluster.
- replica
Parameters MongoCluster Replica Parameters - The parameters to create a replica mongo cluster.
- restore
Parameters MongoCluster Restore Parameters - The parameters to create a point-in-time restore mongo cluster.
- server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties - The sharding properties of the mongo cluster.
- storage
Storage
Properties - The storage properties of the mongo cluster.
- administrator
Administrator
Properties - The local administrator properties for the mongo cluster.
- compute
Compute
Properties - The compute properties of the mongo cluster.
- create_
mode str | CreateMode - The mode to create a mongo cluster.
- high_
availability HighAvailability Properties - The high availability properties of the mongo cluster.
- preview_
features Sequence[Union[str, PreviewFeature]] - List of private endpoint connections.
- public_
network_ str | Publicaccess Network Access - Whether or not public endpoint access is allowed for this mongo cluster.
- replica_
parameters MongoCluster Replica Parameters - The parameters to create a replica mongo cluster.
- restore_
parameters MongoCluster Restore Parameters - The parameters to create a point-in-time restore mongo cluster.
- server_
version str - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties - The sharding properties of the mongo cluster.
- storage
Storage
Properties - The storage properties of the mongo cluster.
- administrator Property Map
- The local administrator properties for the mongo cluster.
- compute Property Map
- The compute properties of the mongo cluster.
- create
Mode String | "Default" | "PointIn Time Restore" | "Geo Replica" | "Replica" - The mode to create a mongo cluster.
- high
Availability Property Map - The high availability properties of the mongo cluster.
- preview
Features List<String | "GeoReplicas"> - List of private endpoint connections.
- public
Network String | "Enabled" | "Disabled"Access - Whether or not public endpoint access is allowed for this mongo cluster.
- replica
Parameters Property Map - The parameters to create a replica mongo cluster.
- restore
Parameters Property Map - The parameters to create a point-in-time restore mongo cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Property Map
- The sharding properties of the mongo cluster.
- storage Property Map
- The storage properties of the mongo cluster.
MongoClusterPropertiesResponse, MongoClusterPropertiesResponseArgs
- Cluster
Status string - The status of the mongo cluster.
- Connection
String string - The default mongo connection string for the cluster.
- Infrastructure
Version string - The infrastructure version the cluster is provisioned on.
- Private
Endpoint List<Pulumi.Connections Azure Native. Mongo Cluster. Inputs. Private Endpoint Connection Response> - List of private endpoint connections.
- Provisioning
State string - The provisioning state of the mongo cluster.
- Replica
Pulumi.
Azure Native. Mongo Cluster. Inputs. Replication Properties Response - The replication properties for the mongo cluster
- Administrator
Pulumi.
Azure Native. Mongo Cluster. Inputs. Administrator Properties Response - The local administrator properties for the mongo cluster.
- Backup
Pulumi.
Azure Native. Mongo Cluster. Inputs. Backup Properties Response - The backup properties of the mongo cluster.
- Compute
Pulumi.
Azure Native. Mongo Cluster. Inputs. Compute Properties Response - The compute properties of the mongo cluster.
- High
Availability Pulumi.Azure Native. Mongo Cluster. Inputs. High Availability Properties Response - The high availability properties of the mongo cluster.
- Preview
Features List<string> - List of private endpoint connections.
- Public
Network stringAccess - Whether or not public endpoint access is allowed for this mongo cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Pulumi.
Azure Native. Mongo Cluster. Inputs. Sharding Properties Response - The sharding properties of the mongo cluster.
- Storage
Pulumi.
Azure Native. Mongo Cluster. Inputs. Storage Properties Response - The storage properties of the mongo cluster.
- Cluster
Status string - The status of the mongo cluster.
- Connection
String string - The default mongo connection string for the cluster.
- Infrastructure
Version string - The infrastructure version the cluster is provisioned on.
- Private
Endpoint []PrivateConnections Endpoint Connection Response - List of private endpoint connections.
- Provisioning
State string - The provisioning state of the mongo cluster.
- Replica
Replication
Properties Response - The replication properties for the mongo cluster
- Administrator
Administrator
Properties Response - The local administrator properties for the mongo cluster.
- Backup
Backup
Properties Response - The backup properties of the mongo cluster.
- Compute
Compute
Properties Response - The compute properties of the mongo cluster.
- High
Availability HighAvailability Properties Response - The high availability properties of the mongo cluster.
- Preview
Features []string - List of private endpoint connections.
- Public
Network stringAccess - Whether or not public endpoint access is allowed for this mongo cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties Response - The sharding properties of the mongo cluster.
- Storage
Storage
Properties Response - The storage properties of the mongo cluster.
- cluster
Status String - The status of the mongo cluster.
- connection
String String - The default mongo connection string for the cluster.
- infrastructure
Version String - The infrastructure version the cluster is provisioned on.
- private
Endpoint List<PrivateConnections Endpoint Connection Response> - List of private endpoint connections.
- provisioning
State String - The provisioning state of the mongo cluster.
- replica
Replication
Properties Response - The replication properties for the mongo cluster
- administrator
Administrator
Properties Response - The local administrator properties for the mongo cluster.
- backup
Backup
Properties Response - The backup properties of the mongo cluster.
- compute
Compute
Properties Response - The compute properties of the mongo cluster.
- high
Availability HighAvailability Properties Response - The high availability properties of the mongo cluster.
- preview
Features List<String> - List of private endpoint connections.
- public
Network StringAccess - Whether or not public endpoint access is allowed for this mongo cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties Response - The sharding properties of the mongo cluster.
- storage
Storage
Properties Response - The storage properties of the mongo cluster.
- cluster
Status string - The status of the mongo cluster.
- connection
String string - The default mongo connection string for the cluster.
- infrastructure
Version string - The infrastructure version the cluster is provisioned on.
- private
Endpoint PrivateConnections Endpoint Connection Response[] - List of private endpoint connections.
- provisioning
State string - The provisioning state of the mongo cluster.
- replica
Replication
Properties Response - The replication properties for the mongo cluster
- administrator
Administrator
Properties Response - The local administrator properties for the mongo cluster.
- backup
Backup
Properties Response - The backup properties of the mongo cluster.
- compute
Compute
Properties Response - The compute properties of the mongo cluster.
- high
Availability HighAvailability Properties Response - The high availability properties of the mongo cluster.
- preview
Features string[] - List of private endpoint connections.
- public
Network stringAccess - Whether or not public endpoint access is allowed for this mongo cluster.
- server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties Response - The sharding properties of the mongo cluster.
- storage
Storage
Properties Response - The storage properties of the mongo cluster.
- cluster_
status str - The status of the mongo cluster.
- connection_
string str - The default mongo connection string for the cluster.
- infrastructure_
version str - The infrastructure version the cluster is provisioned on.
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] - List of private endpoint connections.
- provisioning_
state str - The provisioning state of the mongo cluster.
- replica
Replication
Properties Response - The replication properties for the mongo cluster
- administrator
Administrator
Properties Response - The local administrator properties for the mongo cluster.
- backup
Backup
Properties Response - The backup properties of the mongo cluster.
- compute
Compute
Properties Response - The compute properties of the mongo cluster.
- high_
availability HighAvailability Properties Response - The high availability properties of the mongo cluster.
- preview_
features Sequence[str] - List of private endpoint connections.
- public_
network_ straccess - Whether or not public endpoint access is allowed for this mongo cluster.
- server_
version str - The Mongo DB server version. Defaults to the latest available version if not specified.
- Sharding
Properties Response - The sharding properties of the mongo cluster.
- storage
Storage
Properties Response - The storage properties of the mongo cluster.
- cluster
Status String - The status of the mongo cluster.
- connection
String String - The default mongo connection string for the cluster.
- infrastructure
Version String - The infrastructure version the cluster is provisioned on.
- private
Endpoint List<Property Map>Connections - List of private endpoint connections.
- provisioning
State String - The provisioning state of the mongo cluster.
- replica Property Map
- The replication properties for the mongo cluster
- administrator Property Map
- The local administrator properties for the mongo cluster.
- backup Property Map
- The backup properties of the mongo cluster.
- compute Property Map
- The compute properties of the mongo cluster.
- high
Availability Property Map - The high availability properties of the mongo cluster.
- preview
Features List<String> - List of private endpoint connections.
- public
Network StringAccess - Whether or not public endpoint access is allowed for this mongo cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Property Map
- The sharding properties of the mongo cluster.
- storage Property Map
- The storage properties of the mongo cluster.
MongoClusterReplicaParameters, MongoClusterReplicaParametersArgs
- Source
Location string - The location of the source cluster
- Source
Resource stringId - The id of the replication source cluster.
- Source
Location string - The location of the source cluster
- Source
Resource stringId - The id of the replication source cluster.
- source
Location String - The location of the source cluster
- source
Resource StringId - The id of the replication source cluster.
- source
Location string - The location of the source cluster
- source
Resource stringId - The id of the replication source cluster.
- source_
location str - The location of the source cluster
- source_
resource_ strid - The id of the replication source cluster.
- source
Location String - The location of the source cluster
- source
Resource StringId - The id of the replication source cluster.
MongoClusterRestoreParameters, MongoClusterRestoreParametersArgs
- Point
In stringTime UTC - UTC point in time to restore a mongo cluster
- Source
Resource stringId - Resource ID to locate the source cluster to restore
- Point
In stringTime UTC - UTC point in time to restore a mongo cluster
- Source
Resource stringId - Resource ID to locate the source cluster to restore
- point
In StringTime UTC - UTC point in time to restore a mongo cluster
- source
Resource StringId - Resource ID to locate the source cluster to restore
- point
In stringTime UTC - UTC point in time to restore a mongo cluster
- source
Resource stringId - Resource ID to locate the source cluster to restore
- point_
in_ strtime_ utc - UTC point in time to restore a mongo cluster
- source_
resource_ strid - Resource ID to locate the source cluster to restore
- point
In StringTime UTC - UTC point in time to restore a mongo cluster
- source
Resource StringId - Resource ID to locate the source cluster to restore
PreviewFeature, PreviewFeatureArgs
- Geo
Replicas - GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
- Preview
Feature Geo Replicas - GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
- Geo
Replicas - GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
- Geo
Replicas - GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
- GEO_REPLICAS
- GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
- "Geo
Replicas" - GeoReplicasEnables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.
PrivateEndpointConnectionResponse, PrivateEndpointConnectionResponseArgs
- Group
Ids List<string> - The group ids for the private endpoint resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Private
Link Pulumi.Service Connection State Azure Native. Mongo Cluster. Inputs. Private Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string - The provisioning state of the private endpoint connection resource.
- System
Data Pulumi.Azure Native. Mongo Cluster. Inputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Private
Endpoint Pulumi.Azure Native. Mongo Cluster. Inputs. Private Endpoint Response - The private endpoint resource.
- Group
Ids []string - The group ids for the private endpoint resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string - The provisioning state of the private endpoint connection resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids List<String> - The group ids for the private endpoint resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String - The provisioning state of the private endpoint connection resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids string[] - The group ids for the private endpoint resource.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State string - The provisioning state of the private endpoint connection resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group_
ids Sequence[str] - The group ids for the private endpoint resource.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning_
state str - The provisioning state of the private endpoint connection resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- private_
endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids List<String> - The group ids for the private endpoint resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String - The provisioning state of the private endpoint connection resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- private
Endpoint Property Map - The private endpoint resource.
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id string
- The ARM identifier for private endpoint.
- Id string
- The ARM identifier for private endpoint.
- id String
- The ARM identifier for private endpoint.
- id string
- The ARM identifier for private endpoint.
- id str
- The ARM identifier for private endpoint.
- id String
- The ARM identifier for private endpoint.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status str
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
PublicNetworkAccess, PublicNetworkAccessArgs
- Enabled
- EnabledIf set, mongo cluster can be accessed through private and public methods.
- Disabled
- DisabledIf set, the private endpoints are the exclusive access method.
- Public
Network Access Enabled - EnabledIf set, mongo cluster can be accessed through private and public methods.
- Public
Network Access Disabled - DisabledIf set, the private endpoints are the exclusive access method.
- Enabled
- EnabledIf set, mongo cluster can be accessed through private and public methods.
- Disabled
- DisabledIf set, the private endpoints are the exclusive access method.
- Enabled
- EnabledIf set, mongo cluster can be accessed through private and public methods.
- Disabled
- DisabledIf set, the private endpoints are the exclusive access method.
- ENABLED
- EnabledIf set, mongo cluster can be accessed through private and public methods.
- DISABLED
- DisabledIf set, the private endpoints are the exclusive access method.
- "Enabled"
- EnabledIf set, mongo cluster can be accessed through private and public methods.
- "Disabled"
- DisabledIf set, the private endpoints are the exclusive access method.
ReplicationPropertiesResponse, ReplicationPropertiesResponseArgs
- Replication
State string - The replication link state of the replica cluster.
- Role string
- The replication role of the cluster
- Source
Resource stringId - The resource id the source cluster for the replica cluster.
- Replication
State string - The replication link state of the replica cluster.
- Role string
- The replication role of the cluster
- Source
Resource stringId - The resource id the source cluster for the replica cluster.
- replication
State String - The replication link state of the replica cluster.
- role String
- The replication role of the cluster
- source
Resource StringId - The resource id the source cluster for the replica cluster.
- replication
State string - The replication link state of the replica cluster.
- role string
- The replication role of the cluster
- source
Resource stringId - The resource id the source cluster for the replica cluster.
- replication_
state str - The replication link state of the replica cluster.
- role str
- The replication role of the cluster
- source_
resource_ strid - The resource id the source cluster for the replica cluster.
- replication
State String - The replication link state of the replica cluster.
- role String
- The replication role of the cluster
- source
Resource StringId - The resource id the source cluster for the replica cluster.
ShardingProperties, ShardingPropertiesArgs
- int
- Number of shards to provision on the cluster.
- int
- Number of shards to provision on the cluster.
- Integer
- Number of shards to provision on the cluster.
- number
- Number of shards to provision on the cluster.
- int
- Number of shards to provision on the cluster.
- Number
- Number of shards to provision on the cluster.
ShardingPropertiesResponse, ShardingPropertiesResponseArgs
- int
- Number of shards to provision on the cluster.
- int
- Number of shards to provision on the cluster.
- Integer
- Number of shards to provision on the cluster.
- number
- Number of shards to provision on the cluster.
- int
- Number of shards to provision on the cluster.
- Number
- Number of shards to provision on the cluster.
StorageProperties, StoragePropertiesArgs
- Size
Gb double - The size of the data disk assigned to each server.
- Size
Gb float64 - The size of the data disk assigned to each server.
- size
Gb Double - The size of the data disk assigned to each server.
- size
Gb number - The size of the data disk assigned to each server.
- size_
gb float - The size of the data disk assigned to each server.
- size
Gb Number - The size of the data disk assigned to each server.
StoragePropertiesResponse, StoragePropertiesResponseArgs
- Size
Gb double - The size of the data disk assigned to each server.
- Size
Gb float64 - The size of the data disk assigned to each server.
- size
Gb Double - The size of the data disk assigned to each server.
- size
Gb number - The size of the data disk assigned to each server.
- size_
gb float - The size of the data disk assigned to each server.
- size
Gb Number - The size of the data disk assigned to each server.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:mongocluster:MongoCluster myReplicaMongoCluster /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0