GremlinGraph

Manages a Gremlin Graph within a Cosmos DB Account.

Create a GremlinGraph Resource

new GremlinGraph(name: string, args: GremlinGraphArgs, opts?: CustomResourceOptions);

def GremlinGraph(resource_name, opts=None, account_name=None, conflict_resolution_policies=None, database_name=None, index_policies=None, name=None, partition_key_path=None, resource_group_name=None, throughput=None, unique_keys=None, __props__=None);

func NewGremlinGraph(ctx *Context, name string, args GremlinGraphArgs, opts ...ResourceOption) (*GremlinGraph, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

GremlinGraph Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
ConflictResolutionPolicies List<GremlinGraphConflictResolutionPolicyArgs>: 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.
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.
IndexPolicies List<GremlinGraphIndexPolicyArgs>: The configuration of the indexing policy. One or more index_policy blocks as defined below. 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.
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.
Throughput int: The throughput of the Gremlin database (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
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.
ConflictResolutionPolicies []GremlinGraphConflictResolutionPolicy: 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.
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.
IndexPolicies []GremlinGraphIndexPolicy: The configuration of the indexing policy. One or more index_policy blocks as defined below. 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.
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.
Throughput int: The throughput of the Gremlin database (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
UniqueKeys []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.
conflictResolutionPolicies GremlinGraphConflictResolutionPolicy[]: 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.
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.
indexPolicies GremlinGraphIndexPolicy[]: The configuration of the indexing policy. One or more index_policy blocks as defined below. 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.
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.
throughput number: The throughput of the Gremlin database (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
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.
conflict_resolution_policies List[GremlinGraphConflictResolutionPolicy]: 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.
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.
index_policies List[GremlinGraphIndexPolicy]: The configuration of the indexing policy. One or more index_policy blocks as defined below. 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.
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.
throughput float: 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.
unique_keys List[GremlinGraphUniqueKey]: 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 str: 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

static get(resource_name, id, opts=None, account_name=None, conflict_resolution_policies=None, database_name=None, index_policies=None, name=None, partition_key_path=None, resource_group_name=None, throughput=None, unique_keys=None, __props__=None);

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)

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.

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.
ConflictResolutionPolicies List<GremlinGraphConflictResolutionPolicyArgs>: 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.
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.
IndexPolicies List<GremlinGraphIndexPolicyArgs>: The configuration of the indexing policy. One or more index_policy blocks as defined below. Changing this forces a new resource to be created.
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.
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 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.
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.
ConflictResolutionPolicies []GremlinGraphConflictResolutionPolicy: 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.
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.
IndexPolicies []GremlinGraphIndexPolicy: The configuration of the indexing policy. One or more index_policy blocks as defined below. Changing this forces a new resource to be created.
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.
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 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.
UniqueKeys []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.
conflictResolutionPolicies GremlinGraphConflictResolutionPolicy[]: 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.
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.
indexPolicies GremlinGraphIndexPolicy[]: The configuration of the indexing policy. One or more index_policy blocks as defined below. Changing this forces a new resource to be created.
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.
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 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.
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.
conflict_resolution_policies List[GremlinGraphConflictResolutionPolicy]: 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.
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.
index_policies List[GremlinGraphIndexPolicy]: The configuration of the indexing policy. One or more index_policy blocks as defined below. Changing this forces a new resource to be created.
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.
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 float: 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.
unique_keys List[GremlinGraphUniqueKey]: One or more unique_key blocks as defined below. Changing this forces a new resource to be created.

Supporting Types

GremlinGraphConflictResolutionPolicy

See the input and output API doc for this type.

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.
conflictResolutionPath str: The conflict resolution path in the case of LastWriterWins mode.
conflictResolutionProcedure str: The procedure to resolve conflicts in the case of custom mode.

GremlinGraphIndexPolicy

See the input and output API doc for this type.

IndexingMode string: Indicates the indexing mode. Possible values include: Consistent, Lazy, None.
Automatic bool: Indicates if the indexing policy is automatic. Defaults to true.
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.

IndexingMode string: Indicates the indexing mode. Possible values include: Consistent, Lazy, None.
Automatic bool: Indicates if the indexing policy is automatic. Defaults to true.
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.

indexingMode string: Indicates the indexing mode. Possible values include: Consistent, Lazy, None.
automatic boolean: Indicates if the indexing policy is automatic. Defaults to true.
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.

indexingMode str: Indicates the indexing mode. Possible values include: Consistent, Lazy, None.
automatic bool: Indicates if the indexing policy is automatic. Defaults to true.
excludedPaths List[str]: List of paths to exclude from indexing. Required if indexing_mode is Consistent or Lazy.
includedPaths List[str]: List of paths to include in the indexing. Required if indexing_mode is Consistent or Lazy.

GremlinGraphUniqueKey

See the input and output API doc for this type.

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 string[]: A list of paths to use for this unique key.

paths List[str]: A list of paths to use for this unique key.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GremlinGraph

Create a GremlinGraph Resource

GremlinGraph Resource Properties

Inputs

Outputs

Look up an Existing GremlinGraph Resource

Supporting Types

GremlinGraphConflictResolutionPolicy

GremlinGraphIndexPolicy

GremlinGraphUniqueKey

Package Details

On This Page