1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. GremlinDatabase

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.cosmosdb.GremlinDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Gremlin Database within a Cosmos DB Account.

    Example Usage

    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 exampleGremlinDatabase = new azure.cosmosdb.GremlinDatabase("example", {
        name: "tfex-cosmos-gremlin-db",
        resourceGroupName: example.then(example => example.resourceGroupName),
        accountName: example.then(example => example.name),
        throughput: 400,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
        resource_group_name="tfex-cosmosdb-account-rg")
    example_gremlin_database = azure.cosmosdb.GremlinDatabase("example",
        name="tfex-cosmos-gremlin-db",
        resource_group_name=example.resource_group_name,
        account_name=example.name,
        throughput=400)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
    			Name:              "tfex-cosmosdb-account",
    			ResourceGroupName: "tfex-cosmosdb-account-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = cosmosdb.NewGremlinDatabase(ctx, "example", &cosmosdb.GremlinDatabaseArgs{
    			Name:              pulumi.String("tfex-cosmos-gremlin-db"),
    			ResourceGroupName: pulumi.String(example.ResourceGroupName),
    			AccountName:       pulumi.String(example.Name),
    			Throughput:        pulumi.Int(400),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.CosmosDB.GetAccount.Invoke(new()
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        });
    
        var exampleGremlinDatabase = new Azure.CosmosDB.GremlinDatabase("example", new()
        {
            Name = "tfex-cosmos-gremlin-db",
            ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
            AccountName = example.Apply(getAccountResult => getAccountResult.Name),
            Throughput = 400,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
    import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
    import com.pulumi.azure.cosmosdb.GremlinDatabase;
    import com.pulumi.azure.cosmosdb.GremlinDatabaseArgs;
    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) {
            final var example = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
                .name("tfex-cosmosdb-account")
                .resourceGroupName("tfex-cosmosdb-account-rg")
                .build());
    
            var exampleGremlinDatabase = new GremlinDatabase("exampleGremlinDatabase", GremlinDatabaseArgs.builder()        
                .name("tfex-cosmos-gremlin-db")
                .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
                .throughput(400)
                .build());
    
        }
    }
    
    resources:
      exampleGremlinDatabase:
        type: azure:cosmosdb:GremlinDatabase
        name: example
        properties:
          name: tfex-cosmos-gremlin-db
          resourceGroupName: ${example.resourceGroupName}
          accountName: ${example.name}
          throughput: 400
    variables:
      example:
        fn::invoke:
          Function: azure:cosmosdb:getAccount
          Arguments:
            name: tfex-cosmosdb-account
            resourceGroupName: tfex-cosmosdb-account-rg
    

    Create GremlinDatabase Resource

    new GremlinDatabase(name: string, args: GremlinDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def GremlinDatabase(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        account_name: Optional[str] = None,
                        autoscale_settings: Optional[GremlinDatabaseAutoscaleSettingsArgs] = None,
                        name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        throughput: Optional[int] = None)
    @overload
    def GremlinDatabase(resource_name: str,
                        args: GremlinDatabaseArgs,
                        opts: Optional[ResourceOptions] = None)
    func NewGremlinDatabase(ctx *Context, name string, args GremlinDatabaseArgs, opts ...ResourceOption) (*GremlinDatabase, error)
    public GremlinDatabase(string name, GremlinDatabaseArgs args, CustomResourceOptions? opts = null)
    public GremlinDatabase(String name, GremlinDatabaseArgs args)
    public GremlinDatabase(String name, GremlinDatabaseArgs args, CustomResourceOptions options)
    
    type: azure:cosmosdb:GremlinDatabase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args GremlinDatabaseArgs
    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 GremlinDatabaseArgs
    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 GremlinDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GremlinDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GremlinDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GremlinDatabase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GremlinDatabase resource accepts the following input properties:

    AccountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    Name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AccountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings GremlinDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    Name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName String
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    autoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name String
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    throughput Integer

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    autoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    throughput number

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    account_name str
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    autoscale_settings GremlinDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name str
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName String
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    autoscaleSettings Property Map

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name String
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    throughput Number

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GremlinDatabase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GremlinDatabase Resource

    Get an existing GremlinDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GremlinDatabaseState, opts?: CustomResourceOptions): GremlinDatabase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            autoscale_settings: Optional[GremlinDatabaseAutoscaleSettingsArgs] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            throughput: Optional[int] = None) -> GremlinDatabase
    func GetGremlinDatabase(ctx *Context, name string, id IDInput, state *GremlinDatabaseState, opts ...ResourceOption) (*GremlinDatabase, error)
    public static GremlinDatabase Get(string name, Input<string> id, GremlinDatabaseState? state, CustomResourceOptions? opts = null)
    public static GremlinDatabase get(String name, Output<String> id, GremlinDatabaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    AutoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    Name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AccountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    AutoscaleSettings GremlinDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    Name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName String
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    autoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name String
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    throughput Integer

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName string
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    autoscaleSettings GremlinDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name string
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    throughput number

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    account_name str
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    autoscale_settings GremlinDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name str
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    throughput int

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    accountName String
    The name of the CosmosDB Account to create the Gremlin Database within. Changing this forces a new resource to be created.
    autoscaleSettings Property Map

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual 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.

    name String
    Specifies the name of the Cosmos DB Gremlin Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Gremlin Database is created. Changing this forces a new resource to be created.
    throughput Number

    The throughput of the Gremlin database (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 resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    Supporting Types

    GremlinDatabaseAutoscaleSettings, GremlinDatabaseAutoscaleSettingsArgs

    MaxThroughput int
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    MaxThroughput int
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput Integer
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput number
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    max_throughput int
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput Number
    The maximum throughput of the Gremlin database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

    Import

    CosmosDB Gremlin Databases can be imported using the resource id, e.g.

    $ pulumi import azure:cosmosdb/gremlinDatabase:GremlinDatabase db1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/gremlinDatabases/db1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi