1. Docs
  2. Reference
  3. API
  4. @pulumi/gcp
  5. datastore

Module datastore

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource DataStoreIndex

class DataStoreIndex extends CustomResource

Describes a composite index for Cloud Datastore.

To get more information about Index, see:

Example Usage - Datastore Index

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultDataStoreIndex = new gcp.datastore.DataStoreIndex("default", {
    kind: "foo",
    properties: [
        {
            direction: "ASCENDING",
            name: "propertyA",
        },
        {
            direction: "ASCENDING",
            name: "propertyB",
        },
    ],
});

constructor

new DataStoreIndex(name: string, args: DataStoreIndexArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataStoreIndexState, opts?: pulumi.CustomResourceOptions): DataStoreIndex

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DataStoreIndex

Returns true if the given object is an instance of DataStoreIndex. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property ancestor

public ancestor: pulumi.Output<string | undefined>;

Policy for including ancestors in the index.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property indexId

public indexId: pulumi.Output<string>;

The index id.

property kind

public kind: pulumi.Output<string>;

The entity kind which the index applies to.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property properties

public properties: pulumi.Output<DataStoreIndexProperty[] | undefined>;

An ordered list of properties to index on. Structure is documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface DataStoreIndexArgs

interface DataStoreIndexArgs

The set of arguments for constructing a DataStoreIndex resource.

property ancestor

ancestor?: pulumi.Input<string>;

Policy for including ancestors in the index.

property kind

kind: pulumi.Input<string>;

The entity kind which the index applies to.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property properties

properties?: pulumi.Input<pulumi.Input<DataStoreIndexProperty>[]>;

An ordered list of properties to index on. Structure is documented below.

interface DataStoreIndexState

interface DataStoreIndexState

Input properties used for looking up and filtering DataStoreIndex resources.

property ancestor

ancestor?: pulumi.Input<string>;

Policy for including ancestors in the index.

property indexId

indexId?: pulumi.Input<string>;

The index id.

property kind

kind?: pulumi.Input<string>;

The entity kind which the index applies to.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property properties

properties?: pulumi.Input<pulumi.Input<DataStoreIndexProperty>[]>;

An ordered list of properties to index on. Structure is documented below.