com.pulumi.azurenative.documentdb.MongoDBResourceMongoDBCollection 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.MongoDBResourceMongoDBCollectionArgs;
import com.pulumi.azurenative.documentdb.outputs.MongoDBCollectionGetPropertiesResponseOptions;
import com.pulumi.azurenative.documentdb.outputs.MongoDBCollectionGetPropertiesResponseResource;
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;
/**
* An Azure Cosmos DB MongoDB collection.
* Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.
*
* Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview.
*
* ## Example Usage
* ### CosmosDBMongoDBCollectionCreateUpdate
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.documentdb.MongoDBResourceMongoDBCollection;
* import com.pulumi.azurenative.documentdb.MongoDBResourceMongoDBCollectionArgs;
* import com.pulumi.azurenative.documentdb.inputs.CreateUpdateOptionsArgs;
* import com.pulumi.azurenative.documentdb.inputs.MongoDBCollectionResourceArgs;
* 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 mongoDBResourceMongoDBCollection = new MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollection", MongoDBResourceMongoDBCollectionArgs.builder()
* .accountName("ddb1")
* .collectionName("collectionName")
* .databaseName("databaseName")
* .location("West US")
* .options()
* .resource(MongoDBCollectionResourceArgs.builder()
* .id("collectionName")
* .indexes(
* MongoIndexArgs.builder()
* .key(MongoIndexKeysArgs.builder()
* .keys("_ts")
* .build())
* .options(MongoIndexOptionsArgs.builder()
* .expireAfterSeconds(100)
* .unique(true)
* .build())
* .build(),
* MongoIndexArgs.builder()
* .key(MongoIndexKeysArgs.builder()
* .keys("_id")
* .build())
* .build())
* .shardKey(Map.of("testKey", "Hash"))
* .build())
* .resourceGroupName("rg1")
* .tags()
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:documentdb:MongoDBResourceMongoDBCollection collectionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
* ```
*
*/
@ResourceType(type="azure-native:documentdb:MongoDBResourceMongoDBCollection")
public class MongoDBResourceMongoDBCollection extends com.pulumi.resources.CustomResource {
/**
* The location of the resource group to which the resource belongs.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return The location of the resource group to which the resource belongs.
*
*/
public Output> location() {
return Codegen.optional(this.location);
}
/**
* The name of the ARM resource.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the ARM resource.
*
*/
public Output name() {
return this.name;
}
@Export(name="options", refs={MongoDBCollectionGetPropertiesResponseOptions.class}, tree="[0]")
private Output options;
public Output> options() {
return Codegen.optional(this.options);
}
@Export(name="resource", refs={MongoDBCollectionGetPropertiesResponseResource.class}, tree="[0]")
private Output resource;
public Output> resource() {
return Codegen.optional(this.resource);
}
/**
* Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The type of Azure resource.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of Azure resource.
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public MongoDBResourceMongoDBCollection(java.lang.String name) {
this(name, MongoDBResourceMongoDBCollectionArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public MongoDBResourceMongoDBCollection(java.lang.String name, MongoDBResourceMongoDBCollectionArgs 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 MongoDBResourceMongoDBCollection(java.lang.String name, MongoDBResourceMongoDBCollectionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:documentdb:MongoDBResourceMongoDBCollection", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private MongoDBResourceMongoDBCollection(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:documentdb:MongoDBResourceMongoDBCollection", name, null, makeResourceOptions(options, id), false);
}
private static MongoDBResourceMongoDBCollectionArgs makeArgs(MongoDBResourceMongoDBCollectionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? MongoDBResourceMongoDBCollectionArgs.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/v20150401:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20150408:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20151106:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20160319:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20160331:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20190801:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20191212:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20200301:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20200401:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20200601preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20200901:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210115:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210301preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210315:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210401preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210415:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210515:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210615:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20210701preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20211015:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20211015preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20211115preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20220215preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20220515:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20220515preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20220815:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20220815preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20221115:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20221115preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230301preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230315:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230315preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230415:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230915:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20230915preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20231115:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20231115preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240215preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240515:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240515preview:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240815:MongoDBResourceMongoDBCollection").build()),
Output.of(Alias.builder().type("azure-native:documentdb/v20240901preview:MongoDBResourceMongoDBCollection").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 MongoDBResourceMongoDBCollection get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new MongoDBResourceMongoDBCollection(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy