com.pulumi.azurenative.documentdb.MongoCluster Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.documentdb;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.documentdb.MongoClusterArgs;
import com.pulumi.azurenative.documentdb.outputs.NodeGroupSpecResponse;
import com.pulumi.azurenative.documentdb.outputs.SystemDataResponse;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Represents a mongo cluster resource.
* Azure REST API version: 2023-03-15-preview.
*
* Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview, 2024-06-01-preview, 2024-07-01.
*
* ## Example Usage
* ### Create a new mongo cluster
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.documentdb.MongoCluster;
* import com.pulumi.azurenative.documentdb.MongoClusterArgs;
* import com.pulumi.azurenative.documentdb.inputs.NodeGroupSpecArgs;
* 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()
* .administratorLogin("mongoAdmin")
* .administratorLoginPassword("password")
* .location("westus2")
* .mongoClusterName("myMongoCluster")
* .nodeGroupSpecs(NodeGroupSpecArgs.builder()
* .diskSizeGB(128)
* .enableHa(true)
* .kind("Shard")
* .nodeCount(3)
* .sku("M30")
* .build())
* .resourceGroupName("TestResourceGroup")
* .serverVersion("5.0")
* .build());
*
* }
* }
*
* }
*
* ### Create a new mongo cluster with point in time restore
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.documentdb.MongoCluster;
* import com.pulumi.azurenative.documentdb.MongoClusterArgs;
* import com.pulumi.azurenative.documentdb.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()
* .createMode("PointInTimeRestore")
* .location("westus2")
* .mongoClusterName("myMongoCluster")
* .resourceGroupName("TestResourceGroup")
* .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());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:documentdb:MongoCluster myMongoCluster /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
* ```
*
*/
@ResourceType(type="azure-native:documentdb:MongoCluster")
public class MongoCluster extends com.pulumi.resources.CustomResource {
/**
* The administrator's login for the mongo cluster.
*
*/
@Export(name="administratorLogin", refs={String.class}, tree="[0]")
private Output administratorLogin;
/**
* @return The administrator's login for the mongo cluster.
*
*/
public Output> administratorLogin() {
return Codegen.optional(this.administratorLogin);
}
/**
* A status of the mongo cluster.
*
*/
@Export(name="clusterStatus", refs={String.class}, tree="[0]")
private Output clusterStatus;
/**
* @return A status of the mongo cluster.
*
*/
public Output clusterStatus() {
return this.clusterStatus;
}
/**
* The default mongo connection string for the cluster.
*
*/
@Export(name="connectionString", refs={String.class}, tree="[0]")
private Output connectionString;
/**
* @return The default mongo connection string for the cluster.
*
*/
public Output connectionString() {
return this.connectionString;
}
/**
* Earliest restore timestamp in UTC ISO8601 format.
*
*/
@Export(name="earliestRestoreTime", refs={String.class}, tree="[0]")
private Output earliestRestoreTime;
/**
* @return Earliest restore timestamp in UTC ISO8601 format.
*
*/
public Output earliestRestoreTime() {
return this.earliestRestoreTime;
}
/**
* The geo-location where the resource lives
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return The geo-location where the resource lives
*
*/
public Output location() {
return this.location;
}
/**
* The name of the resource
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource
*
*/
public Output name() {
return this.name;
}
/**
* The list of node group specs in the cluster.
*
*/
@Export(name="nodeGroupSpecs", refs={List.class,NodeGroupSpecResponse.class}, tree="[0,1]")
private Output> nodeGroupSpecs;
/**
* @return The list of node group specs in the cluster.
*
*/
public Output>> nodeGroupSpecs() {
return Codegen.optional(this.nodeGroupSpecs);
}
/**
* A provisioning state of the mongo cluster.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return A provisioning state of the mongo cluster.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The Mongo DB server version. Defaults to the latest available version if not specified.
*
*/
@Export(name="serverVersion", refs={String.class}, tree="[0]")
private Output serverVersion;
/**
* @return The Mongo DB server version. Defaults to the latest available version if not specified.
*
*/
public Output> serverVersion() {
return Codegen.optional(this.serverVersion);
}
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
public Output systemData() {
return this.systemData;
}
/**
* Resource tags.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Resource tags.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public MongoCluster(java.lang.String name) {
this(name, MongoClusterArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public MongoCluster(java.lang.String name, MongoClusterArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public MongoCluster(java.lang.String name, MongoClusterArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:documentdb:MongoCluster", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private MongoCluster(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:documentdb:MongoCluster", name, null, makeResourceOptions(options, id), false);
}
private static MongoClusterArgs makeArgs(MongoClusterArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? MongoClusterArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:documentdb/v20230301preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230315preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230915preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20231115preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240215preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240301preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240601preview:MongoCluster").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240701:MongoCluster").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static MongoCluster get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new MongoCluster(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy