import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Mongo Collection within a Cosmos DB Account. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = azure.cosmosdb.getAccount({ * name: "tfex-cosmosdb-account", * resourceGroupName: "tfex-cosmosdb-account-rg", * }); * const exampleMongoDatabase = new azure.cosmosdb.MongoDatabase("example", { * name: "tfex-cosmos-mongo-db", * resourceGroupName: example.then(example => example.resourceGroupName), * accountName: example.then(example => example.name), * }); * const exampleMongoCollection = new azure.cosmosdb.MongoCollection("example", { * name: "tfex-cosmos-mongo-db", * resourceGroupName: example.then(example => example.resourceGroupName), * accountName: example.then(example => example.name), * databaseName: exampleMongoDatabase.name, * defaultTtlSeconds: 777, * shardKey: "uniqueKey", * throughput: 400, * indices: [{ * keys: ["_id"], * unique: true, * }], * }); * ``` * * ## Import * * CosmosDB Mongo Collection can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:cosmosdb/mongoCollection:MongoCollection collection1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbDatabases/db1/collections/collection1 * ``` */ export declare class MongoCollection extends pulumi.CustomResource { /** * Get an existing MongoCollection 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: MongoCollectionState, opts?: pulumi.CustomResourceOptions): MongoCollection; /** * Returns true if the given object is an instance of MongoCollection. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is MongoCollection; /** * The name of the Cosmos DB Account in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ readonly accountName: pulumi.Output; /** * The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to `-1`, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number `n` – items will expire `n` seconds after their last modified time. */ readonly analyticalStorageTtl: pulumi.Output; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ readonly autoscaleSettings: pulumi.Output; /** * The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ readonly databaseName: pulumi.Output; /** * The default Time To Live in seconds. If the value is `-1`, items are not automatically expired. */ readonly defaultTtlSeconds: pulumi.Output; /** * One or more `index` blocks as defined below. */ readonly indices: pulumi.Output; /** * Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The name of the key to partition on for sharding. There must not be any other unique index keys. Changing this forces a new resource to be created. */ readonly shardKey: pulumi.Output; /** * One or more `systemIndexes` blocks as defined below. */ readonly systemIndexes: pulumi.Output; /** * The throughput of the MongoDB collection (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. */ readonly throughput: pulumi.Output; /** * Create a MongoCollection resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: MongoCollectionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering MongoCollection resources. */ export interface MongoCollectionState { /** * The name of the Cosmos DB Account in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ accountName?: pulumi.Input; /** * The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to `-1`, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number `n` – items will expire `n` seconds after their last modified time. */ analyticalStorageTtl?: pulumi.Input; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ autoscaleSettings?: pulumi.Input; /** * The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ databaseName?: pulumi.Input; /** * The default Time To Live in seconds. If the value is `-1`, items are not automatically expired. */ defaultTtlSeconds?: pulumi.Input; /** * One or more `index` blocks as defined below. */ indices?: pulumi.Input[]>; /** * Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The name of the key to partition on for sharding. There must not be any other unique index keys. Changing this forces a new resource to be created. */ shardKey?: pulumi.Input; /** * One or more `systemIndexes` blocks as defined below. */ systemIndexes?: pulumi.Input[]>; /** * The throughput of the MongoDB collection (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. */ throughput?: pulumi.Input; } /** * The set of arguments for constructing a MongoCollection resource. */ export interface MongoCollectionArgs { /** * The name of the Cosmos DB Account in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ accountName: pulumi.Input; /** * The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to `-1`, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number `n` – items will expire `n` seconds after their last modified time. */ analyticalStorageTtl?: pulumi.Input; /** * An `autoscaleSettings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. * * > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed. */ autoscaleSettings?: pulumi.Input; /** * The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ databaseName: pulumi.Input; /** * The default Time To Live in seconds. If the value is `-1`, items are not automatically expired. */ defaultTtlSeconds?: pulumi.Input; /** * One or more `index` blocks as defined below. */ indices?: pulumi.Input[]>; /** * Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * The name of the key to partition on for sharding. There must not be any other unique index keys. Changing this forces a new resource to be created. */ shardKey?: pulumi.Input; /** * The throughput of the MongoDB collection (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual terraform destroy-apply. */ throughput?: pulumi.Input; }