Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Friday, Jun 10, 2022 by Pulumi

GremlinGraph

Manages a Gremlin Graph within a Cosmos DB Account.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleAccount = Output.Create(Azure.CosmosDB.GetAccount.InvokeAsync(new Azure.CosmosDB.GetAccountArgs
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        }));
        var exampleGremlinDatabase = new Azure.CosmosDB.GremlinDatabase("exampleGremlinDatabase", new Azure.CosmosDB.GremlinDatabaseArgs
        {
            ResourceGroupName = exampleAccount.Apply(exampleAccount => exampleAccount.ResourceGroupName),
            AccountName = exampleAccount.Apply(exampleAccount => exampleAccount.Name),
        });
        var exampleGremlinGraph = new Azure.CosmosDB.GremlinGraph("exampleGremlinGraph", new Azure.CosmosDB.GremlinGraphArgs
        {
            ResourceGroupName = azurerm_cosmosdb_account.Example.Resource_group_name,
            AccountName = azurerm_cosmosdb_account.Example.Name,
            DatabaseName = exampleGremlinDatabase.Name,
            PartitionKeyPath = "/Example",
            Throughput = 400,
            IndexPolicy = new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicyArgs
            {
                Automatic = true,
                IndexingMode = "Consistent",
                IncludedPaths = 
                {
                    "/*",
                },
                ExcludedPaths = 
                {
                    "/\"_etag\"/?",
                },
            },
            ConflictResolutionPolicy = new Azure.CosmosDB.Inputs.GremlinGraphConflictResolutionPolicyArgs
            {
                Mode = "LastWriterWins",
                ConflictResolutionPath = "/_ts",
            },
            UniqueKeys = 
            {
                new Azure.CosmosDB.Inputs.GremlinGraphUniqueKeyArgs
                {
                    Paths = 
                    {
                        "/definition/id1",
                        "/definition/id2",
                    },
                },
            },
        });
    }

}
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 {
		exampleAccount, 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, "exampleGremlinDatabase", &cosmosdb.GremlinDatabaseArgs{
			ResourceGroupName: pulumi.String(exampleAccount.ResourceGroupName),
			AccountName:       pulumi.String(exampleAccount.Name),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewGremlinGraph(ctx, "exampleGremlinGraph", &cosmosdb.GremlinGraphArgs{
			ResourceGroupName: pulumi.Any(azurerm_cosmosdb_account.Example.Resource_group_name),
			AccountName:       pulumi.Any(azurerm_cosmosdb_account.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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleAccount = Output.of(CosmosdbFunctions.getAccount(GetAccountArgs.builder()
            .name("tfex-cosmosdb-account")
            .resourceGroupName("tfex-cosmosdb-account-rg")
            .build()));

        var exampleGremlinDatabase = new GremlinDatabase("exampleGremlinDatabase", GremlinDatabaseArgs.builder()        
            .resourceGroupName(exampleAccount.apply(getAccountResult -> getAccountResult.resourceGroupName()))
            .accountName(exampleAccount.apply(getAccountResult -> getAccountResult.name()))
            .build());

        var exampleGremlinGraph = new GremlinGraph("exampleGremlinGraph", GremlinGraphArgs.builder()        
            .resourceGroupName(azurerm_cosmosdb_account.example().resource_group_name())
            .accountName(azurerm_cosmosdb_account.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());

    }
}
import pulumi
import pulumi_azure as azure

example_account = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
    resource_group_name="tfex-cosmosdb-account-rg")
example_gremlin_database = azure.cosmosdb.GremlinDatabase("exampleGremlinDatabase",
    resource_group_name=example_account.resource_group_name,
    account_name=example_account.name)
example_gremlin_graph = azure.cosmosdb.GremlinGraph("exampleGremlinGraph",
    resource_group_name=azurerm_cosmosdb_account["example"]["resource_group_name"],
    account_name=azurerm_cosmosdb_account["example"]["name"],
    database_name=example_gremlin_database.name,
    partition_key_path="/Example",
    throughput=400,
    index_policy=azure.cosmosdb.GremlinGraphIndexPolicyArgs(
        automatic=True,
        indexing_mode="Consistent",
        included_paths=["/*"],
        excluded_paths=["/\"_etag\"/?"],
    ),
    conflict_resolution_policy=azure.cosmosdb.GremlinGraphConflictResolutionPolicyArgs(
        mode="LastWriterWins",
        conflict_resolution_path="/_ts",
    ),
    unique_keys=[azure.cosmosdb.GremlinGraphUniqueKeyArgs(
        paths=[
            "/definition/id1",
            "/definition/id2",
        ],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleAccount = azure.cosmosdb.getAccount({
    name: "tfex-cosmosdb-account",
    resourceGroupName: "tfex-cosmosdb-account-rg",
});
const exampleGremlinDatabase = new azure.cosmosdb.GremlinDatabase("exampleGremlinDatabase", {
    resourceGroupName: exampleAccount.then(exampleAccount => exampleAccount.resourceGroupName),
    accountName: exampleAccount.then(exampleAccount => exampleAccount.name),
});
const exampleGremlinGraph = new azure.cosmosdb.GremlinGraph("exampleGremlinGraph", {
    resourceGroupName: azurerm_cosmosdb_account.example.resource_group_name,
    accountName: azurerm_cosmosdb_account.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",
        ],
    }],
});
resources:
  exampleGremlinDatabase:
    type: azure:cosmosdb:GremlinDatabase
    properties:
      resourceGroupName: ${exampleAccount.resourceGroupName}
      accountName: ${exampleAccount.name}
  exampleGremlinGraph:
    type: azure:cosmosdb:GremlinGraph
    properties:
      resourceGroupName: ${azurerm_cosmosdb_account.example.resource_group_name}
      accountName: ${azurerm_cosmosdb_account.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:
  exampleAccount:
    Fn::Invoke:
      Function: azure:cosmosdb:getAccount
      Arguments:
        name: tfex-cosmosdb-account
        resourceGroupName: tfex-cosmosdb-account-rg

Create a GremlinGraph Resource

new GremlinGraph(name: string, args: GremlinGraphArgs, opts?: CustomResourceOptions);
@overload
def GremlinGraph(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_name: Optional[str] = None,
                 autoscale_settings: Optional[GremlinGraphAutoscaleSettingsArgs] = None,
                 conflict_resolution_policy: Optional[GremlinGraphConflictResolutionPolicyArgs] = None,
                 database_name: Optional[str] = None,
                 default_ttl: Optional[int] = None,
                 index_policy: Optional[GremlinGraphIndexPolicyArgs] = None,
                 name: Optional[str] = None,
                 partition_key_path: Optional[str] = None,
                 partition_key_version: Optional[int] = None,
                 resource_group_name: Optional[str] = None,
                 throughput: Optional[int] = None,
                 unique_keys: Optional[Sequence[GremlinGraphUniqueKeyArgs]] = None)
@overload
def GremlinGraph(resource_name: str,
                 args: GremlinGraphArgs,
                 opts: Optional[ResourceOptions] = None)
func NewGremlinGraph(ctx *Context, name string, args GremlinGraphArgs, opts ...ResourceOption) (*GremlinGraph, error)
public GremlinGraph(string name, GremlinGraphArgs args, CustomResourceOptions? opts = null)
public GremlinGraph(String name, GremlinGraphArgs args)
public GremlinGraph(String name, GremlinGraphArgs args, CustomResourceOptions options)
type: azure:cosmosdb:GremlinGraph
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args GremlinGraphArgs
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 GremlinGraphArgs
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 GremlinGraphArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GremlinGraphArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GremlinGraphArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

GremlinGraph 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 GremlinGraph resource accepts the following input properties:

AccountName string

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

DatabaseName 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.

PartitionKeyPath string

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

ResourceGroupName 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.

AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

DefaultTtl int

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

IndexPolicy GremlinGraphIndexPolicyArgs

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

Name string

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

PartitionKeyVersion int

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

Throughput 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 List<GremlinGraphUniqueKeyArgs>

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

AccountName string

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

DatabaseName 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.

PartitionKeyPath string

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

ResourceGroupName 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.

AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

DefaultTtl int

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

IndexPolicy GremlinGraphIndexPolicyArgs

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

Name string

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

PartitionKeyVersion int

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

Throughput 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 []GremlinGraphUniqueKeyArgs

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

accountName String

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

databaseName 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.

partitionKeyPath String

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

resourceGroupName 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.

autoscaleSettings GremlinGraphAutoscaleSettingsArgs
conflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

defaultTtl Integer

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

indexPolicy GremlinGraphIndexPolicyArgs

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

name String

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

partitionKeyVersion Integer

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

throughput Integer

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 List<GremlinGraphUniqueKeyArgs>

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

accountName string

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

databaseName 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.

partitionKeyPath string

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

resourceGroupName 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.

autoscaleSettings GremlinGraphAutoscaleSettingsArgs
conflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

defaultTtl number

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

indexPolicy GremlinGraphIndexPolicyArgs

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

name string

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

partitionKeyVersion number

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

throughput number

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 GremlinGraphUniqueKeyArgs[]

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

account_name str

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

database_name str

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.

partition_key_path str

Define a partition key. 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 Graph is created. Changing this forces a new resource to be created.

autoscale_settings GremlinGraphAutoscaleSettingsArgs
conflict_resolution_policy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

default_ttl int

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

index_policy GremlinGraphIndexPolicyArgs

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

name str

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

partition_key_version int

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

throughput 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.

unique_keys Sequence[GremlinGraphUniqueKeyArgs]

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

accountName String

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

databaseName 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.

partitionKeyPath String

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

resourceGroupName 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.

autoscaleSettings Property Map
conflictResolutionPolicy Property Map

A conflict_resolution_policy blocks as defined below.

defaultTtl Number

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

indexPolicy Property Map

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

name String

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

partitionKeyVersion Number

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

throughput Number

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 List<Property Map>

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

Outputs

All input properties are implicitly available as output properties. Additionally, the GremlinGraph 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 an Existing GremlinGraph Resource

Get an existing GremlinGraph 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?: GremlinGraphState, opts?: CustomResourceOptions): GremlinGraph
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        autoscale_settings: Optional[GremlinGraphAutoscaleSettingsArgs] = None,
        conflict_resolution_policy: Optional[GremlinGraphConflictResolutionPolicyArgs] = None,
        database_name: Optional[str] = None,
        default_ttl: Optional[int] = None,
        index_policy: Optional[GremlinGraphIndexPolicyArgs] = None,
        name: Optional[str] = None,
        partition_key_path: Optional[str] = None,
        partition_key_version: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        throughput: Optional[int] = None,
        unique_keys: Optional[Sequence[GremlinGraphUniqueKeyArgs]] = None) -> GremlinGraph
func GetGremlinGraph(ctx *Context, name string, id IDInput, state *GremlinGraphState, opts ...ResourceOption) (*GremlinGraph, error)
public static GremlinGraph Get(string name, Input<string> id, GremlinGraphState? state, CustomResourceOptions? opts = null)
public static GremlinGraph get(String name, Output<String> id, GremlinGraphState 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 Graph within. Changing this forces a new resource to be created.

AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

DatabaseName 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 int

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

IndexPolicy GremlinGraphIndexPolicyArgs

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

Name string

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

PartitionKeyPath string

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

PartitionKeyVersion int

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

ResourceGroupName 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 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 List<GremlinGraphUniqueKeyArgs>

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

AccountName string

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

AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

DatabaseName 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 int

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

IndexPolicy GremlinGraphIndexPolicyArgs

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

Name string

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

PartitionKeyPath string

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

PartitionKeyVersion int

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

ResourceGroupName 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 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 []GremlinGraphUniqueKeyArgs

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

accountName String

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

autoscaleSettings GremlinGraphAutoscaleSettingsArgs
conflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

databaseName 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 Integer

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

indexPolicy GremlinGraphIndexPolicyArgs

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

name String

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

partitionKeyPath String

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

partitionKeyVersion Integer

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

resourceGroupName 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 Integer

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 List<GremlinGraphUniqueKeyArgs>

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

accountName string

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

autoscaleSettings GremlinGraphAutoscaleSettingsArgs
conflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

databaseName 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 number

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

indexPolicy GremlinGraphIndexPolicyArgs

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

name string

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

partitionKeyPath string

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

partitionKeyVersion number

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

resourceGroupName 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 number

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 GremlinGraphUniqueKeyArgs[]

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

account_name str

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

autoscale_settings GremlinGraphAutoscaleSettingsArgs
conflict_resolution_policy GremlinGraphConflictResolutionPolicyArgs

A conflict_resolution_policy blocks as defined below.

database_name str

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.

default_ttl int

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

index_policy GremlinGraphIndexPolicyArgs

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

name str

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

partition_key_path str

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

partition_key_version int

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

resource_group_name str

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 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.

unique_keys Sequence[GremlinGraphUniqueKeyArgs]

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

accountName String

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

autoscaleSettings Property Map
conflictResolutionPolicy Property Map

A conflict_resolution_policy blocks as defined below.

databaseName 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 Number

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

indexPolicy Property Map

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

name String

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

partitionKeyPath String

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

partitionKeyVersion Number

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

resourceGroupName 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 Number

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 List<Property Map>

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

Supporting Types

GremlinGraphAutoscaleSettings

MaxThroughput int

The maximum throughput of the Gremlin graph (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 graph (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 graph (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 graph (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 graph (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 graph (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

GremlinGraphConflictResolutionPolicy

Mode string

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

ConflictResolutionPath string

The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure string

The procedure to resolve conflicts in the case of custom mode.

Mode string

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

ConflictResolutionPath string

The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure string

The procedure to resolve conflicts in the case of custom mode.

mode String

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

conflictResolutionPath String

The conflict resolution path in the case of LastWriterWins mode.

conflictResolutionProcedure String

The procedure to resolve conflicts in the case of custom mode.

mode string

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

conflictResolutionPath string

The conflict resolution path in the case of LastWriterWins mode.

conflictResolutionProcedure string

The procedure to resolve conflicts in the case of custom mode.

mode str

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

conflict_resolution_path str

The conflict resolution path in the case of LastWriterWins mode.

conflict_resolution_procedure str

The procedure to resolve conflicts in the case of custom mode.

mode String

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

conflictResolutionPath String

The conflict resolution path in the case of LastWriterWins mode.

conflictResolutionProcedure String

The procedure to resolve conflicts in the case of custom mode.

GremlinGraphIndexPolicy

IndexingMode string

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

Automatic bool

Indicates if the indexing policy is automatic. Defaults to true.

CompositeIndices List<GremlinGraphIndexPolicyCompositeIndex>

One or more composite_index blocks as defined below.

ExcludedPaths List<string>

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

IncludedPaths List<string>

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

SpatialIndices List<GremlinGraphIndexPolicySpatialIndex>

One or more spatial_index blocks as defined below.

IndexingMode string

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

Automatic bool

Indicates if the indexing policy is automatic. Defaults to true.

CompositeIndices []GremlinGraphIndexPolicyCompositeIndex

One or more composite_index blocks as defined below.

ExcludedPaths []string

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

IncludedPaths []string

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

SpatialIndices []GremlinGraphIndexPolicySpatialIndex

One or more spatial_index blocks as defined below.

indexingMode String

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

automatic Boolean

Indicates if the indexing policy is automatic. Defaults to true.

compositeIndices List<GremlinGraphIndexPolicyCompositeIndex>

One or more composite_index blocks as defined below.

excludedPaths List<String>

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

includedPaths List<String>

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

spatialIndices List<GremlinGraphIndexPolicySpatialIndex>

One or more spatial_index blocks as defined below.

indexingMode string

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

automatic boolean

Indicates if the indexing policy is automatic. Defaults to true.

compositeIndices GremlinGraphIndexPolicyCompositeIndex[]

One or more composite_index blocks as defined below.

excludedPaths string[]

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

includedPaths string[]

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

spatialIndices GremlinGraphIndexPolicySpatialIndex[]

One or more spatial_index blocks as defined below.

indexing_mode str

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

automatic bool

Indicates if the indexing policy is automatic. Defaults to true.

composite_indices Sequence[GremlinGraphIndexPolicyCompositeIndex]

One or more composite_index blocks as defined below.

excluded_paths Sequence[str]

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

included_paths Sequence[str]

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

spatial_indices Sequence[GremlinGraphIndexPolicySpatialIndex]

One or more spatial_index blocks as defined below.

indexingMode String

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

automatic Boolean

Indicates if the indexing policy is automatic. Defaults to true.

compositeIndices List<Property Map>

One or more composite_index blocks as defined below.

excludedPaths List<String>

List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.

includedPaths List<String>

List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

spatialIndices List<Property Map>

One or more spatial_index blocks as defined below.

GremlinGraphIndexPolicyCompositeIndex

Indices List<GremlinGraphIndexPolicyCompositeIndexIndex>

One or more index blocks as defined below.

Indices []GremlinGraphIndexPolicyCompositeIndexIndex

One or more index blocks as defined below.

indices List<GremlinGraphIndexPolicyCompositeIndexIndex>

One or more index blocks as defined below.

indices GremlinGraphIndexPolicyCompositeIndexIndex[]

One or more index blocks as defined below.

indices Sequence[GremlinGraphIndexPolicyCompositeIndexIndex]

One or more index blocks as defined below.

indices List<Property Map>

One or more index blocks as defined below.

GremlinGraphIndexPolicyCompositeIndexIndex

Order string

Order of the index. Possible values are Ascending or Descending.

Path string

Path for which the indexing behaviour applies to.

Order string

Order of the index. Possible values are Ascending or Descending.

Path string

Path for which the indexing behaviour applies to.

order String

Order of the index. Possible values are Ascending or Descending.

path String

Path for which the indexing behaviour applies to.

order string

Order of the index. Possible values are Ascending or Descending.

path string

Path for which the indexing behaviour applies to.

order str

Order of the index. Possible values are Ascending or Descending.

path str

Path for which the indexing behaviour applies to.

order String

Order of the index. Possible values are Ascending or Descending.

path String

Path for which the indexing behaviour applies to.

GremlinGraphIndexPolicySpatialIndex

Path string

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

Types List<string>
Path string

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

Types []string
path String

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

types List<String>
path string

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

types string[]
path str

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

types Sequence[str]
path String

Path for which the indexing behaviour applies to. According to the service design, all spatial types including LineString, MultiPolygon, Point, and Polygon will be applied to the path.

types List<String>

GremlinGraphUniqueKey

Paths List<string>

A list of paths to use for this unique key.

Paths []string

A list of paths to use for this unique key.

paths List<String>

A list of paths to use for this unique key.

paths string[]

A list of paths to use for this unique key.

paths Sequence[str]

A list of paths to use for this unique key.

paths List<String>

A list of paths to use for this unique key.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.