Class GremlinGraph

Manages a Gremlin Graph within a Cosmos DB Account.

Inheritance

System.Object

Resource

CustomResource

GremlinGraph

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.CosmosDB

Assembly: Pulumi.Azure.dll

Syntax

public class GremlinGraph : CustomResource

Constructors

GremlinGraph(String, GremlinGraphArgs, CustomResourceOptions)

Create a GremlinGraph resource with the given unique name, arguments, and options.

Declaration

public GremlinGraph(string name, GremlinGraphArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GremlinGraphArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccountName

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

Declaration

public Output<string> AccountName { get; }

Property Value

Type	Description
Output<System.String>

ConflictResolutionPolicies

The conflict resolution policy for the graph. One or more conflict_resolution_policy blocks as defined below. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<GremlinGraphConflictResolutionPolicy>> ConflictResolutionPolicies { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GremlinGraphConflictResolutionPolicy>>

DatabaseName

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.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

IndexPolicies

The configuration of the indexing policy. One or more index_policy blocks as defined below. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<GremlinGraphIndexPolicy>> IndexPolicies { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GremlinGraphIndexPolicy>>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PartitionKeyPath

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

Declaration

public Output<string> PartitionKeyPath { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Throughput

The throughput of the Gremlin database (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

Declaration

public Output<int> Throughput { get; }

Property Value

Type	Description
Output<System.Int32>

UniqueKeys

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

Declaration

public Output<ImmutableArray<GremlinGraphUniqueKey>> UniqueKeys { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GremlinGraphUniqueKey>>

Methods

Get(String, Input<String>, GremlinGraphState, CustomResourceOptions)

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

Declaration

public static GremlinGraph Get(string name, Input<string> id, GremlinGraphState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GremlinGraphState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
GremlinGraph