DataStoreIndex

Describes a composite index for Cloud Datastore.

To get more information about Index, see:

API documentation
How-to Guides
- Official Documentation

Create a DataStoreIndex Resource

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

def DataStoreIndex(resource_name, opts=None, ancestor=None, kind=None, project=None, properties=None, __props__=None);

func NewDataStoreIndex(ctx *Context, name string, args DataStoreIndexArgs, opts ...ResourceOption) (*DataStoreIndex, error)

public DataStoreIndex(string name, DataStoreIndexArgs args, CustomResourceOptions? opts = null)

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

name string: The unique name of the resource.
args DataStoreIndexArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

DataStoreIndex Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The DataStoreIndex resource accepts the following input properties:

Kind string: The entity kind which the index applies to.
Ancestor string: Policy for including ancestors in the index.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Properties List<DataStoreIndexPropertyArgs>: An ordered list of properties to index on. Structure is documented below.

Kind string: The entity kind which the index applies to.
Ancestor string: Policy for including ancestors in the index.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Properties []DataStoreIndexProperty: An ordered list of properties to index on. Structure is documented below.

kind string: The entity kind which the index applies to.
ancestor string: Policy for including ancestors in the index.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
properties DataStoreIndexProperty[]: An ordered list of properties to index on. Structure is documented below.

kind str: The entity kind which the index applies to.
ancestor str: Policy for including ancestors in the index.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
properties List[DataStoreIndexProperty]: An ordered list of properties to index on. Structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
IndexId string: The index id.

Id string: The provider-assigned unique ID for this managed resource.
IndexId string: The index id.

id string: The provider-assigned unique ID for this managed resource.
indexId string: The index id.

id str: The provider-assigned unique ID for this managed resource.
index_id str: The index id.

Look up an Existing DataStoreIndex Resource

Get an existing DataStoreIndex 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?: DataStoreIndexState, opts?: CustomResourceOptions): DataStoreIndex

static get(resource_name, id, opts=None, ancestor=None, index_id=None, kind=None, project=None, properties=None, __props__=None);

func GetDataStoreIndex(ctx *Context, name string, id IDInput, state *DataStoreIndexState, opts ...ResourceOption) (*DataStoreIndex, error)

public static DataStoreIndex Get(string name, Input<string> id, DataStoreIndexState? 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:

Ancestor string: Policy for including ancestors in the index.
IndexId string: The index id.
Kind string: The entity kind which the index applies to.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Properties List<DataStoreIndexPropertyArgs>: An ordered list of properties to index on. Structure is documented below.

Ancestor string: Policy for including ancestors in the index.
IndexId string: The index id.
Kind string: The entity kind which the index applies to.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Properties []DataStoreIndexProperty: An ordered list of properties to index on. Structure is documented below.

ancestor string: Policy for including ancestors in the index.
indexId string: The index id.
kind string: The entity kind which the index applies to.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
properties DataStoreIndexProperty[]: An ordered list of properties to index on. Structure is documented below.

ancestor str: Policy for including ancestors in the index.
index_id str: The index id.
kind str: The entity kind which the index applies to.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
properties List[DataStoreIndexProperty]: An ordered list of properties to index on. Structure is documented below.

Supporting Types

DataStoreIndexProperty

See the input and output API doc for this type.

Direction string: The direction the index should optimize for sorting.
Name string: The property name to index.

Direction string: The direction the index should optimize for sorting.
Name string: The property name to index.

direction string: The direction the index should optimize for sorting.
name string: The property name to index.

direction str: The direction the index should optimize for sorting.
name str: The property name to index.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud