pulumi-azure-native-kotlin/com.pulumi.azurenative.mongocluster.kotlin/MongoCluster

MongoCluster

class MongoCluster : KotlinCustomResource

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/#accessing-any-api-version-via-local-packages 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",
    });
});
Content copied to clipboard
package main
import (
	mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v2"
	"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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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",
    });
});
Content copied to clipboard
package main
import (
	mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v2"
	"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
	})
}
Content copied to clipboard
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)
                    .build())
                .build())
            .resourceGroupName("TestResourceGroup")
            .build());
    }
}
Content copied to clipboard

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",
    });
});
Content copied to clipboard
package main
import (
	mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v2"
	"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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val properties: Output<MongoClusterPropertiesResponse>

The resource-specific properties for this resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>