azure-native.documentdb.GremlinResourceGremlinDatabase

Explore with Pulumi AI

An Azure Cosmos DB Gremlin database. API Version: 2021-03-15.

Example Usage

CosmosDBGremlinDatabaseCreateUpdate

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var gremlinResourceGremlinDatabase = new AzureNative.DocumentDB.GremlinResourceGremlinDatabase("gremlinResourceGremlinDatabase", new()
    {
        AccountName = "ddb1",
        DatabaseName = "databaseName",
        Location = "West US",
        Options = null,
        Resource = new AzureNative.DocumentDB.Inputs.GremlinDatabaseResourceArgs
        {
            Id = "databaseName",
        },
        ResourceGroupName = "rg1",
        Tags = null,
    });

});
package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native/sdk/go/azure/documentdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewGremlinResourceGremlinDatabase(ctx, "gremlinResourceGremlinDatabase", &documentdb.GremlinResourceGremlinDatabaseArgs{
			AccountName:  pulumi.String("ddb1"),
			DatabaseName: pulumi.String("databaseName"),
			Location:     pulumi.String("West US"),
			Options:      nil,
			Resource: &documentdb.GremlinDatabaseResourceArgs{
				Id: pulumi.String("databaseName"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			Tags:              nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.GremlinResourceGremlinDatabase;
import com.pulumi.azurenative.documentdb.GremlinResourceGremlinDatabaseArgs;
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) {
        var gremlinResourceGremlinDatabase = new GremlinResourceGremlinDatabase("gremlinResourceGremlinDatabase", GremlinResourceGremlinDatabaseArgs.builder()        
            .accountName("ddb1")
            .databaseName("databaseName")
            .location("West US")
            .options()
            .resource(Map.of("id", "databaseName"))
            .resourceGroupName("rg1")
            .tags()
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

gremlin_resource_gremlin_database = azure_native.documentdb.GremlinResourceGremlinDatabase("gremlinResourceGremlinDatabase",
    account_name="ddb1",
    database_name="databaseName",
    location="West US",
    options=azure_native.documentdb.CreateUpdateOptionsArgs(),
    resource=azure_native.documentdb.GremlinDatabaseResourceArgs(
        id="databaseName",
    ),
    resource_group_name="rg1",
    tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gremlinResourceGremlinDatabase = new azure_native.documentdb.GremlinResourceGremlinDatabase("gremlinResourceGremlinDatabase", {
    accountName: "ddb1",
    databaseName: "databaseName",
    location: "West US",
    options: {},
    resource: {
        id: "databaseName",
    },
    resourceGroupName: "rg1",
    tags: {},
});
resources:
  gremlinResourceGremlinDatabase:
    type: azure-native:documentdb:GremlinResourceGremlinDatabase
    properties:
      accountName: ddb1
      databaseName: databaseName
      location: West US
      options: {}
      resource:
        id: databaseName
      resourceGroupName: rg1
      tags: {}

Create GremlinResourceGremlinDatabase Resource

new GremlinResourceGremlinDatabase(name: string, args: GremlinResourceGremlinDatabaseArgs, opts?: CustomResourceOptions);
@overload
def GremlinResourceGremlinDatabase(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   account_name: Optional[str] = None,
                                   database_name: Optional[str] = None,
                                   location: Optional[str] = None,
                                   options: Optional[CreateUpdateOptionsArgs] = None,
                                   resource: Optional[GremlinDatabaseResourceArgs] = None,
                                   resource_group_name: Optional[str] = None,
                                   tags: Optional[Mapping[str, str]] = None)
@overload
def GremlinResourceGremlinDatabase(resource_name: str,
                                   args: GremlinResourceGremlinDatabaseArgs,
                                   opts: Optional[ResourceOptions] = None)
func NewGremlinResourceGremlinDatabase(ctx *Context, name string, args GremlinResourceGremlinDatabaseArgs, opts ...ResourceOption) (*GremlinResourceGremlinDatabase, error)
public GremlinResourceGremlinDatabase(string name, GremlinResourceGremlinDatabaseArgs args, CustomResourceOptions? opts = null)
public GremlinResourceGremlinDatabase(String name, GremlinResourceGremlinDatabaseArgs args)
public GremlinResourceGremlinDatabase(String name, GremlinResourceGremlinDatabaseArgs args, CustomResourceOptions options)
type: azure-native:documentdb:GremlinResourceGremlinDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

AccountName string

Cosmos DB database account name.

Resource Pulumi.AzureNative.DocumentDB.Inputs.GremlinDatabaseResourceArgs

The standard JSON format of a Gremlin database

ResourceGroupName string

The name of the resource group. The name is case insensitive.

DatabaseName string

Cosmos DB database name.

Location string

The location of the resource group to which the resource belongs.

Options Pulumi.AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

Tags Dictionary<string, string>

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

AccountName string

Cosmos DB database account name.

Resource GremlinDatabaseResourceArgs

The standard JSON format of a Gremlin database

ResourceGroupName string

The name of the resource group. The name is case insensitive.

DatabaseName string

Cosmos DB database name.

Location string

The location of the resource group to which the resource belongs.

Options CreateUpdateOptionsArgs

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

Tags map[string]string

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

accountName String

Cosmos DB database account name.

resource GremlinDatabaseResourceArgs

The standard JSON format of a Gremlin database

resourceGroupName String

The name of the resource group. The name is case insensitive.

databaseName String

Cosmos DB database name.

location String

The location of the resource group to which the resource belongs.

options CreateUpdateOptionsArgs

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

tags Map<String,String>

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

accountName string

Cosmos DB database account name.

resource GremlinDatabaseResourceArgs

The standard JSON format of a Gremlin database

resourceGroupName string

The name of the resource group. The name is case insensitive.

databaseName string

Cosmos DB database name.

location string

The location of the resource group to which the resource belongs.

options CreateUpdateOptionsArgs

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

tags {[key: string]: string}

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

account_name str

Cosmos DB database account name.

resource GremlinDatabaseResourceArgs

The standard JSON format of a Gremlin database

resource_group_name str

The name of the resource group. The name is case insensitive.

database_name str

Cosmos DB database name.

location str

The location of the resource group to which the resource belongs.

options CreateUpdateOptionsArgs

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

tags Mapping[str, str]

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

accountName String

Cosmos DB database account name.

resource Property Map

The standard JSON format of a Gremlin database

resourceGroupName String

The name of the resource group. The name is case insensitive.

databaseName String

Cosmos DB database name.

location String

The location of the resource group to which the resource belongs.

options Property Map

A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

tags Map<String>

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

Outputs

All input properties are implicitly available as output properties. Additionally, the GremlinResourceGremlinDatabase resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the ARM resource.

Type string

The type of Azure resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the ARM resource.

Type string

The type of Azure resource.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the ARM resource.

type String

The type of Azure resource.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the ARM resource.

type string

The type of Azure resource.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the ARM resource.

type str

The type of Azure resource.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the ARM resource.

type String

The type of Azure resource.

Supporting Types

AutoscaleSettings

MaxThroughput int

Represents maximum throughput, the resource can scale up to.

MaxThroughput int

Represents maximum throughput, the resource can scale up to.

maxThroughput Integer

Represents maximum throughput, the resource can scale up to.

maxThroughput number

Represents maximum throughput, the resource can scale up to.

max_throughput int

Represents maximum throughput, the resource can scale up to.

maxThroughput Number

Represents maximum throughput, the resource can scale up to.

AutoscaleSettingsResponse

MaxThroughput int

Represents maximum throughput, the resource can scale up to.

MaxThroughput int

Represents maximum throughput, the resource can scale up to.

maxThroughput Integer

Represents maximum throughput, the resource can scale up to.

maxThroughput number

Represents maximum throughput, the resource can scale up to.

max_throughput int

Represents maximum throughput, the resource can scale up to.

maxThroughput Number

Represents maximum throughput, the resource can scale up to.

CreateUpdateOptions

AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettings

Specifies the Autoscale settings.

Throughput int

Request Units per second. For example, "throughput": 10000.

AutoscaleSettings AutoscaleSettings

Specifies the Autoscale settings.

Throughput int

Request Units per second. For example, "throughput": 10000.

autoscaleSettings AutoscaleSettings

Specifies the Autoscale settings.

throughput Integer

Request Units per second. For example, "throughput": 10000.

autoscaleSettings AutoscaleSettings

Specifies the Autoscale settings.

throughput number

Request Units per second. For example, "throughput": 10000.

autoscale_settings AutoscaleSettings

Specifies the Autoscale settings.

throughput int

Request Units per second. For example, "throughput": 10000.

autoscaleSettings Property Map

Specifies the Autoscale settings.

throughput Number

Request Units per second. For example, "throughput": 10000.

GremlinDatabaseGetPropertiesResponseOptions

AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettingsResponse

Specifies the Autoscale settings.

Throughput int

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

AutoscaleSettings AutoscaleSettingsResponse

Specifies the Autoscale settings.

Throughput int

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

autoscaleSettings AutoscaleSettingsResponse

Specifies the Autoscale settings.

throughput Integer

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

autoscaleSettings AutoscaleSettingsResponse

Specifies the Autoscale settings.

throughput number

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

autoscale_settings AutoscaleSettingsResponse

Specifies the Autoscale settings.

throughput int

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

autoscaleSettings Property Map

Specifies the Autoscale settings.

throughput Number

Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

GremlinDatabaseGetPropertiesResponseResource

Etag string

A system generated property representing the resource etag required for optimistic concurrency control.

Id string

Name of the Cosmos DB Gremlin database

Rid string

A system generated property. A unique identifier.

Ts double

A system generated property that denotes the last updated timestamp of the resource.

Etag string

A system generated property representing the resource etag required for optimistic concurrency control.

Id string

Name of the Cosmos DB Gremlin database

Rid string

A system generated property. A unique identifier.

Ts float64

A system generated property that denotes the last updated timestamp of the resource.

etag String

A system generated property representing the resource etag required for optimistic concurrency control.

id String

Name of the Cosmos DB Gremlin database

rid String

A system generated property. A unique identifier.

ts Double

A system generated property that denotes the last updated timestamp of the resource.

etag string

A system generated property representing the resource etag required for optimistic concurrency control.

id string

Name of the Cosmos DB Gremlin database

rid string

A system generated property. A unique identifier.

ts number

A system generated property that denotes the last updated timestamp of the resource.

etag str

A system generated property representing the resource etag required for optimistic concurrency control.

id str

Name of the Cosmos DB Gremlin database

rid str

A system generated property. A unique identifier.

ts float

A system generated property that denotes the last updated timestamp of the resource.

etag String

A system generated property representing the resource etag required for optimistic concurrency control.

id String

Name of the Cosmos DB Gremlin database

rid String

A system generated property. A unique identifier.

ts Number

A system generated property that denotes the last updated timestamp of the resource.

GremlinDatabaseResource

Id string

Name of the Cosmos DB Gremlin database

Id string

Name of the Cosmos DB Gremlin database

id String

Name of the Cosmos DB Gremlin database

id string

Name of the Cosmos DB Gremlin database

id str

Name of the Cosmos DB Gremlin database

id String

Name of the Cosmos DB Gremlin database

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:documentdb:GremlinResourceGremlinDatabase databaseName /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName 

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0