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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.cosmosdb.GremlinGraph

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    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=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",
            ],
        )])
    
    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
    		}
    		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
    	})
    }
    
    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 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.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
                .build());
    
            var exampleGremlinGraph = new GremlinGraph("exampleGremlinGraph", GremlinGraphArgs.builder()
                .name("tfex-cosmos-gremlin-graph")
                .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.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.

    Create GremlinGraph Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GremlinGraph(name: string, args: GremlinGraphArgs, opts?: CustomResourceOptions);
    @overload
    def GremlinGraph(resource_name: str,
                     args: GremlinGraphArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def GremlinGraph(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     database_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     partition_key_path: Optional[str] = None,
                     account_name: Optional[str] = None,
                     index_policy: Optional[GremlinGraphIndexPolicyArgs] = None,
                     default_ttl: Optional[int] = None,
                     conflict_resolution_policy: Optional[GremlinGraphConflictResolutionPolicyArgs] = None,
                     name: Optional[str] = None,
                     autoscale_settings: Optional[GremlinGraphAutoscaleSettingsArgs] = None,
                     partition_key_version: Optional[int] = None,
                     analytical_storage_ttl: Optional[int] = None,
                     throughput: Optional[int] = None,
                     unique_keys: Optional[Sequence[GremlinGraphUniqueKeyArgs]] = 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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gremlinGraphResource = new Azure.CosmosDB.GremlinGraph("gremlinGraphResource", new()
    {
        DatabaseName = "string",
        ResourceGroupName = "string",
        PartitionKeyPath = "string",
        AccountName = "string",
        IndexPolicy = new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicyArgs
        {
            IndexingMode = "string",
            Automatic = false,
            CompositeIndices = new[]
            {
                new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicyCompositeIndexArgs
                {
                    Indices = new[]
                    {
                        new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicyCompositeIndexIndexArgs
                        {
                            Order = "string",
                            Path = "string",
                        },
                    },
                },
            },
            ExcludedPaths = new[]
            {
                "string",
            },
            IncludedPaths = new[]
            {
                "string",
            },
            SpatialIndices = new[]
            {
                new Azure.CosmosDB.Inputs.GremlinGraphIndexPolicySpatialIndexArgs
                {
                    Path = "string",
                    Types = new[]
                    {
                        "string",
                    },
                },
            },
        },
        DefaultTtl = 0,
        ConflictResolutionPolicy = new Azure.CosmosDB.Inputs.GremlinGraphConflictResolutionPolicyArgs
        {
            Mode = "string",
            ConflictResolutionPath = "string",
            ConflictResolutionProcedure = "string",
        },
        Name = "string",
        AutoscaleSettings = new Azure.CosmosDB.Inputs.GremlinGraphAutoscaleSettingsArgs
        {
            MaxThroughput = 0,
        },
        PartitionKeyVersion = 0,
        AnalyticalStorageTtl = 0,
        Throughput = 0,
        UniqueKeys = new[]
        {
            new Azure.CosmosDB.Inputs.GremlinGraphUniqueKeyArgs
            {
                Paths = new[]
                {
                    "string",
                },
            },
        },
    });
    
    example, err := cosmosdb.NewGremlinGraph(ctx, "gremlinGraphResource", &cosmosdb.GremlinGraphArgs{
    	DatabaseName:      pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	PartitionKeyPath:  pulumi.String("string"),
    	AccountName:       pulumi.String("string"),
    	IndexPolicy: &cosmosdb.GremlinGraphIndexPolicyArgs{
    		IndexingMode: pulumi.String("string"),
    		Automatic:    pulumi.Bool(false),
    		CompositeIndices: cosmosdb.GremlinGraphIndexPolicyCompositeIndexArray{
    			&cosmosdb.GremlinGraphIndexPolicyCompositeIndexArgs{
    				Indices: cosmosdb.GremlinGraphIndexPolicyCompositeIndexIndexArray{
    					&cosmosdb.GremlinGraphIndexPolicyCompositeIndexIndexArgs{
    						Order: pulumi.String("string"),
    						Path:  pulumi.String("string"),
    					},
    				},
    			},
    		},
    		ExcludedPaths: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IncludedPaths: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SpatialIndices: cosmosdb.GremlinGraphIndexPolicySpatialIndexArray{
    			&cosmosdb.GremlinGraphIndexPolicySpatialIndexArgs{
    				Path: pulumi.String("string"),
    				Types: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    		},
    	},
    	DefaultTtl: pulumi.Int(0),
    	ConflictResolutionPolicy: &cosmosdb.GremlinGraphConflictResolutionPolicyArgs{
    		Mode:                        pulumi.String("string"),
    		ConflictResolutionPath:      pulumi.String("string"),
    		ConflictResolutionProcedure: pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	AutoscaleSettings: &cosmosdb.GremlinGraphAutoscaleSettingsArgs{
    		MaxThroughput: pulumi.Int(0),
    	},
    	PartitionKeyVersion:  pulumi.Int(0),
    	AnalyticalStorageTtl: pulumi.Int(0),
    	Throughput:           pulumi.Int(0),
    	UniqueKeys: cosmosdb.GremlinGraphUniqueKeyArray{
    		&cosmosdb.GremlinGraphUniqueKeyArgs{
    			Paths: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    })
    
    var gremlinGraphResource = new GremlinGraph("gremlinGraphResource", GremlinGraphArgs.builder()
        .databaseName("string")
        .resourceGroupName("string")
        .partitionKeyPath("string")
        .accountName("string")
        .indexPolicy(GremlinGraphIndexPolicyArgs.builder()
            .indexingMode("string")
            .automatic(false)
            .compositeIndices(GremlinGraphIndexPolicyCompositeIndexArgs.builder()
                .indices(GremlinGraphIndexPolicyCompositeIndexIndexArgs.builder()
                    .order("string")
                    .path("string")
                    .build())
                .build())
            .excludedPaths("string")
            .includedPaths("string")
            .spatialIndices(GremlinGraphIndexPolicySpatialIndexArgs.builder()
                .path("string")
                .types("string")
                .build())
            .build())
        .defaultTtl(0)
        .conflictResolutionPolicy(GremlinGraphConflictResolutionPolicyArgs.builder()
            .mode("string")
            .conflictResolutionPath("string")
            .conflictResolutionProcedure("string")
            .build())
        .name("string")
        .autoscaleSettings(GremlinGraphAutoscaleSettingsArgs.builder()
            .maxThroughput(0)
            .build())
        .partitionKeyVersion(0)
        .analyticalStorageTtl(0)
        .throughput(0)
        .uniqueKeys(GremlinGraphUniqueKeyArgs.builder()
            .paths("string")
            .build())
        .build());
    
    gremlin_graph_resource = azure.cosmosdb.GremlinGraph("gremlinGraphResource",
        database_name="string",
        resource_group_name="string",
        partition_key_path="string",
        account_name="string",
        index_policy=azure.cosmosdb.GremlinGraphIndexPolicyArgs(
            indexing_mode="string",
            automatic=False,
            composite_indices=[azure.cosmosdb.GremlinGraphIndexPolicyCompositeIndexArgs(
                indices=[azure.cosmosdb.GremlinGraphIndexPolicyCompositeIndexIndexArgs(
                    order="string",
                    path="string",
                )],
            )],
            excluded_paths=["string"],
            included_paths=["string"],
            spatial_indices=[azure.cosmosdb.GremlinGraphIndexPolicySpatialIndexArgs(
                path="string",
                types=["string"],
            )],
        ),
        default_ttl=0,
        conflict_resolution_policy=azure.cosmosdb.GremlinGraphConflictResolutionPolicyArgs(
            mode="string",
            conflict_resolution_path="string",
            conflict_resolution_procedure="string",
        ),
        name="string",
        autoscale_settings=azure.cosmosdb.GremlinGraphAutoscaleSettingsArgs(
            max_throughput=0,
        ),
        partition_key_version=0,
        analytical_storage_ttl=0,
        throughput=0,
        unique_keys=[azure.cosmosdb.GremlinGraphUniqueKeyArgs(
            paths=["string"],
        )])
    
    const gremlinGraphResource = new azure.cosmosdb.GremlinGraph("gremlinGraphResource", {
        databaseName: "string",
        resourceGroupName: "string",
        partitionKeyPath: "string",
        accountName: "string",
        indexPolicy: {
            indexingMode: "string",
            automatic: false,
            compositeIndices: [{
                indices: [{
                    order: "string",
                    path: "string",
                }],
            }],
            excludedPaths: ["string"],
            includedPaths: ["string"],
            spatialIndices: [{
                path: "string",
                types: ["string"],
            }],
        },
        defaultTtl: 0,
        conflictResolutionPolicy: {
            mode: "string",
            conflictResolutionPath: "string",
            conflictResolutionProcedure: "string",
        },
        name: "string",
        autoscaleSettings: {
            maxThroughput: 0,
        },
        partitionKeyVersion: 0,
        analyticalStorageTtl: 0,
        throughput: 0,
        uniqueKeys: [{
            paths: ["string"],
        }],
    });
    
    type: azure:cosmosdb:GremlinGraph
    properties:
        accountName: string
        analyticalStorageTtl: 0
        autoscaleSettings:
            maxThroughput: 0
        conflictResolutionPolicy:
            conflictResolutionPath: string
            conflictResolutionProcedure: string
            mode: string
        databaseName: string
        defaultTtl: 0
        indexPolicy:
            automatic: false
            compositeIndices:
                - indices:
                    - order: string
                      path: string
            excludedPaths:
                - string
            includedPaths:
                - string
            indexingMode: string
            spatialIndices:
                - path: string
                  types:
                    - string
        name: string
        partitionKeyPath: string
        partitionKeyVersion: 0
        resourceGroupName: string
        throughput: 0
        uniqueKeys:
            - paths:
                - string
    

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

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    AutoscaleSettings GremlinGraphAutoscaleSettings
    ConflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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 GremlinGraphIndexPolicy
    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 1and 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<GremlinGraphUniqueKey>
    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.
    AnalyticalStorageTtl 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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
    ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs
    A conflict_resolution_policy blocks as defined below. 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.
    PartitionKeyVersion 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.
    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.
    analyticalStorageTtl Integer

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings GremlinGraphAutoscaleSettings
    conflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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 GremlinGraphIndexPolicy
    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 1and 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<GremlinGraphUniqueKey>
    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.
    analyticalStorageTtl number

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings GremlinGraphAutoscaleSettings
    conflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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 GremlinGraphIndexPolicy
    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 1and 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 GremlinGraphUniqueKey[]
    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.
    analytical_storage_ttl 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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscale_settings GremlinGraphAutoscaleSettingsArgs
    conflict_resolution_policy GremlinGraphConflictResolutionPolicyArgs
    A conflict_resolution_policy blocks as defined below. 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_version 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.
    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.
    analyticalStorageTtl Number

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings Property Map
    conflictResolutionPolicy Property Map
    A conflict_resolution_policy blocks as defined below. 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.
    partitionKeyVersion Number
    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.
    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 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,
            analytical_storage_ttl: Optional[int] = 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.
    AnalyticalStorageTtl 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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    AutoscaleSettings GremlinGraphAutoscaleSettings
    ConflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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.
    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 GremlinGraphIndexPolicy
    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 1and 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<GremlinGraphUniqueKey>
    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.
    AnalyticalStorageTtl 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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    AutoscaleSettings GremlinGraphAutoscaleSettingsArgs
    ConflictResolutionPolicy GremlinGraphConflictResolutionPolicyArgs
    A conflict_resolution_policy blocks as defined below. 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.
    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 1and 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.
    analyticalStorageTtl Integer

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings GremlinGraphAutoscaleSettings
    conflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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.
    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 GremlinGraphIndexPolicy
    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 1and 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<GremlinGraphUniqueKey>
    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.
    analyticalStorageTtl number

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings GremlinGraphAutoscaleSettings
    conflictResolutionPolicy GremlinGraphConflictResolutionPolicy
    A conflict_resolution_policy blocks as defined below. 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.
    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 GremlinGraphIndexPolicy
    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 1and 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 GremlinGraphUniqueKey[]
    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.
    analytical_storage_ttl 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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscale_settings GremlinGraphAutoscaleSettingsArgs
    conflict_resolution_policy GremlinGraphConflictResolutionPolicyArgs
    A conflict_resolution_policy blocks as defined below. 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.
    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 1and 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.
    analyticalStorageTtl Number

    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.

    Note: Disabling analytical_storage_ttl will force a new resource to be created since it can't be disabled once it's enabled.

    autoscaleSettings Property Map
    conflictResolutionPolicy Property Map
    A conflict_resolution_policy blocks as defined below. 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.
    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 1and 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, GremlinGraphAutoscaleSettingsArgs

    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, GremlinGraphConflictResolutionPolicyArgs

    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, GremlinGraphIndexPolicyArgs

    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, GremlinGraphIndexPolicyCompositeIndexArgs

    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, GremlinGraphIndexPolicyCompositeIndexIndexArgs

    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, GremlinGraphIndexPolicySpatialIndexArgs

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

    Paths List<string>
    A list of paths to use for this unique key. Changing this forces a new resource to be created.
    Paths []string
    A list of paths to use for this unique key. Changing this forces a new resource to be created.
    paths List<String>
    A list of paths to use for this unique key. Changing this forces a new resource to be created.
    paths string[]
    A list of paths to use for this unique key. Changing this forces a new resource to be created.
    paths Sequence[str]
    A list of paths to use for this unique key. Changing this forces a new resource to be created.
    paths List<String>
    A list of paths to use for this unique key. Changing this forces a new resource to be created.

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.81.0 published on Monday, Jun 24, 2024 by Pulumi