pulumi-azure-kotlin/com.pulumi.azure.cosmosdb.kotlin/GremlinGraph

GremlinGraph

class GremlinGraph : KotlinCustomResource

Manages a Gremlin Graph 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),
});
const exampleGremlinGraph = new azure.cosmosdb.GremlinGraph("example", {
    name: "tfex-cosmos-gremlin-graph",
    resourceGroupName: example.then(example => example.resourceGroupName),
    accountName: example.then(example => example.name),
    databaseName: exampleGremlinDatabase.name,
    partitionKeyPath: "/Example",
    throughput: 400,
    indexPolicy: {
        automatic: true,
        indexingMode: "consistent",
        includedPaths: ["/*"],
        excludedPaths: ["/\"_etag\"/?"],
    },
    conflictResolutionPolicy: {
        mode: "LastWriterWins",
        conflictResolutionPath: "/_ts",
    },
    uniqueKeys: [{
        paths: [
            "/definition/id1",
            "/definition/id2",
        ],
    }],
});

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)
example_gremlin_graph = azure.cosmosdb.GremlinGraph("example",
    name="tfex-cosmos-gremlin-graph",
    resource_group_name=example.resource_group_name,
    account_name=example.name,
    database_name=example_gremlin_database.name,
    partition_key_path="/Example",
    throughput=400,
    index_policy={
        "automatic": True,
        "indexing_mode": "consistent",
        "included_paths": ["/*"],
        "excluded_paths": ["/\"_etag\"/?"],
    },
    conflict_resolution_policy={
        "mode": "LastWriterWins",
        "conflict_resolution_path": "/_ts",
    },
    unique_keys=[{
        "paths": [
            "/definition/id1",
            "/definition/id2",
        ],
    }])

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),
    });
    var exampleGremlinGraph = new Azure.CosmosDB.GremlinGraph("example", new()
    {
        Name = "tfex-cosmos-gremlin-graph",
        ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
        AccountName = example.Apply(getAccountResult => getAccountResult.Name),
        DatabaseName = exampleGremlinDatabase.Name,
        PartitionKeyPath = "/Example",
        Throughput = 400,
        IndexPolicy = new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicyArgs
        {
            Automatic = true,
            IndexingMode = "consistent",
            IncludedPaths = new[]
            {
                "/*",
            },
            ExcludedPaths = new[]
            {
                "/\"_etag\"/?",
            },
        },
        ConflictResolutionPolicy = new Azure.CosmosDB.Inputs.GremlinGraphConflictResolutionPolicyArgs
        {
            Mode = "LastWriterWins",
            ConflictResolutionPath = "/_ts",
        },
        UniqueKeys = new[]
        {
            new Azure.CosmosDB.Inputs.GremlinGraphUniqueKeyArgs
            {
                Paths = new[]
                {
                    "/definition/id1",
                    "/definition/id2",
                },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/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
		}
		exampleGremlinDatabase, err := cosmosdb.NewGremlinDatabase(ctx, "example", &cosmosdb.GremlinDatabaseArgs{
			Name:              pulumi.String("tfex-cosmos-gremlin-db"),
			ResourceGroupName: pulumi.String(example.ResourceGroupName),
			AccountName:       pulumi.String(example.Name),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewGremlinGraph(ctx, "example", &cosmosdb.GremlinGraphArgs{
			Name:              pulumi.String("tfex-cosmos-gremlin-graph"),
			ResourceGroupName: pulumi.String(example.ResourceGroupName),
			AccountName:       pulumi.String(example.Name),
			DatabaseName:      exampleGremlinDatabase.Name,
			PartitionKeyPath:  pulumi.String("/Example"),
			Throughput:        pulumi.Int(400),
			IndexPolicy: &cosmosdb.GremlinGraphIndexPolicyArgs{
				Automatic:    pulumi.Bool(true),
				IndexingMode: pulumi.String("consistent"),
				IncludedPaths: pulumi.StringArray{
					pulumi.String("/*"),
				},
				ExcludedPaths: pulumi.StringArray{
					pulumi.String("/\"_etag\"/?"),
				},
			},
			ConflictResolutionPolicy: &cosmosdb.GremlinGraphConflictResolutionPolicyArgs{
				Mode:                   pulumi.String("LastWriterWins"),
				ConflictResolutionPath: pulumi.String("/_ts"),
			},
			UniqueKeys: cosmosdb.GremlinGraphUniqueKeyArray{
				&cosmosdb.GremlinGraphUniqueKeyArgs{
					Paths: pulumi.StringArray{
						pulumi.String("/definition/id1"),
						pulumi.String("/definition/id2"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 com.pulumi.azure.cosmosdb.GremlinGraph;
import com.pulumi.azure.cosmosdb.GremlinGraphArgs;
import com.pulumi.azure.cosmosdb.inputs.GremlinGraphIndexPolicyArgs;
import com.pulumi.azure.cosmosdb.inputs.GremlinGraphConflictResolutionPolicyArgs;
import com.pulumi.azure.cosmosdb.inputs.GremlinGraphUniqueKeyArgs;
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.resourceGroupName())
            .accountName(example.name())
            .build());
        var exampleGremlinGraph = new GremlinGraph("exampleGremlinGraph", GremlinGraphArgs.builder()
            .name("tfex-cosmos-gremlin-graph")
            .resourceGroupName(example.resourceGroupName())
            .accountName(example.name())
            .databaseName(exampleGremlinDatabase.name())
            .partitionKeyPath("/Example")
            .throughput(400)
            .indexPolicy(GremlinGraphIndexPolicyArgs.builder()
                .automatic(true)
                .indexingMode("consistent")
                .includedPaths("/*")
                .excludedPaths("/\"_etag\"/?")
                .build())
            .conflictResolutionPolicy(GremlinGraphConflictResolutionPolicyArgs.builder()
                .mode("LastWriterWins")
                .conflictResolutionPath("/_ts")
                .build())
            .uniqueKeys(GremlinGraphUniqueKeyArgs.builder()
                .paths(
                    "/definition/id1",
                    "/definition/id2")
                .build())
            .build());
    }
}

resources:
  exampleGremlinDatabase:
    type: azure:cosmosdb:GremlinDatabase
    name: example
    properties:
      name: tfex-cosmos-gremlin-db
      resourceGroupName: ${example.resourceGroupName}
      accountName: ${example.name}
  exampleGremlinGraph:
    type: azure:cosmosdb:GremlinGraph
    name: example
    properties:
      name: tfex-cosmos-gremlin-graph
      resourceGroupName: ${example.resourceGroupName}
      accountName: ${example.name}
      databaseName: ${exampleGremlinDatabase.name}
      partitionKeyPath: /Example
      throughput: 400
      indexPolicy:
        automatic: true
        indexingMode: consistent
        includedPaths:
          - /*
        excludedPaths:
          - /"_etag"/?
      conflictResolutionPolicy:
        mode: LastWriterWins
        conflictResolutionPath: /_ts
      uniqueKeys:
        - paths:
            - /definition/id1
            - /definition/id2
variables:
  example:
    fn::invoke:
      function: azure:cosmosdb:getAccount
      arguments:
        name: tfex-cosmosdb-account
        resourceGroupName: tfex-cosmosdb-account-rg

Note: The CosmosDB Account needs to have the EnableGremlin capability enabled to use this resource - which can be done by adding this to the capabilities list within the azure.cosmosdb.Account resource.

Import

Cosmos Gremlin Graphs can be imported using the resource id, e.g.

$ pulumi import azure:cosmosdb/gremlinGraph:GremlinGraph example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/gremlinDatabases/db1/graphs/graphs1

//////

Properties

accountName

val accountName: Output<String>

The name of the CosmosDB Account to create the Gremlin Graph within. Changing this forces a new resource to be created.

analyticalStorageTtl

val analyticalStorageTtl: Output<Int>?

The time to live of Analytical Storage for this Cosmos DB Gremlin Graph. Possible values are between -1 to 2147483647 not including 0. If present and the value is set to -1, it means never expire.

autoscaleSettings

val autoscaleSettings: Output<GremlinGraphAutoscaleSettings>?

conflictResolutionPolicy

val conflictResolutionPolicy: Output<GremlinGraphConflictResolutionPolicy>

A conflict_resolution_policy blocks as defined below. Changing this forces a new resource to be created.

databaseName

val databaseName: Output<String>

The name of the Cosmos DB Graph Database in which the Cosmos DB Gremlin Graph is created. Changing this forces a new resource to be created.

defaultTtl

val defaultTtl: Output<Int>?

The default time to live (TTL) of the Gremlin graph. If the value is missing or set to "-1", items don’t expire.

val id: Output<String>

indexPolicy

val indexPolicy: Output<GremlinGraphIndexPolicy>

The configuration of the indexing policy. One or more index_policy blocks as defined below.

name

val name: Output<String>

Specifies the name of the Cosmos DB Gremlin Graph. Changing this forces a new resource to be created.

partitionKeyPath

val partitionKeyPath: Output<String>

Define a partition key. Changing this forces a new resource to be created.

partitionKeyVersion

val partitionKeyVersion: Output<Int>?

Define a partition key version. Changing this forces a new resource to be created. Possible values are 1and 2. This should be set to 2 in order to use large partition keys.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<String>

The name of the resource group in which the Cosmos DB Gremlin Graph is created. Changing this forces a new resource to be created.

throughput

val throughput: Output<Int>

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

uniqueKeys

val uniqueKeys: Output<List<GremlinGraphUniqueKey>>?

One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

urn

val urn: Output<String>