This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Creates an Index. Auto-naming is currently not supported for this resource.
Create Index Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);@overload
def Index(resource_name: str,
args: IndexArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Index(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
description: Optional[str] = None,
encryption_spec: Optional[GoogleCloudAiplatformV1beta1EncryptionSpecArgs] = None,
etag: Optional[str] = None,
index_update_method: Optional[IndexIndexUpdateMethod] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
metadata: Optional[Any] = None,
metadata_schema_uri: Optional[str] = None,
project: Optional[str] = None)func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)type: google-native:aiplatform/v1beta1:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_aiplatform_v1beta1_index" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IndexArgs
- 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 IndexArgs
- 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 IndexArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var google_nativeIndexResource = new GoogleNative.Aiplatform.V1Beta1.Index("google-nativeIndexResource", new()
{
DisplayName = "string",
Description = "string",
EncryptionSpec = new GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1EncryptionSpecArgs
{
KmsKeyName = "string",
},
Etag = "string",
IndexUpdateMethod = GoogleNative.Aiplatform.V1Beta1.IndexIndexUpdateMethod.IndexUpdateMethodUnspecified,
Labels =
{
{ "string", "string" },
},
Location = "string",
Metadata = "any",
MetadataSchemaUri = "string",
Project = "string",
});
example, err := aiplatformv1beta1.NewIndex(ctx, "google-nativeIndexResource", &aiplatformv1beta1.IndexArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
EncryptionSpec: &aiplatform.GoogleCloudAiplatformV1beta1EncryptionSpecArgs{
KmsKeyName: pulumi.String("string"),
},
Etag: pulumi.String("string"),
IndexUpdateMethod: aiplatformv1beta1.IndexIndexUpdateMethodIndexUpdateMethodUnspecified,
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
Metadata: pulumi.Any("any"),
MetadataSchemaUri: pulumi.String("string"),
Project: pulumi.String("string"),
})
resource "google-native_aiplatform_v1beta1_index" "google-nativeIndexResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
description = "string"
encryption_spec = {
kms_key_name = "string"
}
etag = "string"
index_update_method = "INDEX_UPDATE_METHOD_UNSPECIFIED"
labels = {
"string" = "string"
}
location = "string"
metadata = "any"
metadata_schema_uri = "string"
project = "string"
}
var google_nativeIndexResource = new com.pulumi.googlenative.aiplatform_v1beta1.Index("google-nativeIndexResource", com.pulumi.googlenative.aiplatform_v1beta1.IndexArgs.builder()
.displayName("string")
.description("string")
.encryptionSpec(GoogleCloudAiplatformV1beta1EncryptionSpecArgs.builder()
.kmsKeyName("string")
.build())
.etag("string")
.indexUpdateMethod(com.pulumi.googlenative.aiplatform_v1beta1.enums.IndexIndexUpdateMethod.IndexUpdateMethodUnspecified)
.labels(Map.of("string", "string"))
.location("string")
.metadata("any")
.metadataSchemaUri("string")
.project("string")
.build());
google_native_index_resource = google_native.aiplatform.v1beta1.Index("google-nativeIndexResource",
display_name="string",
description="string",
encryption_spec={
"kms_key_name": "string",
},
etag="string",
index_update_method=google_native.aiplatform.v1beta1.IndexIndexUpdateMethod.INDEX_UPDATE_METHOD_UNSPECIFIED,
labels={
"string": "string",
},
location="string",
metadata="any",
metadata_schema_uri="string",
project="string")
const google_nativeIndexResource = new google_native.aiplatform.v1beta1.Index("google-nativeIndexResource", {
displayName: "string",
description: "string",
encryptionSpec: {
kmsKeyName: "string",
},
etag: "string",
indexUpdateMethod: google_native.aiplatform.v1beta1.IndexIndexUpdateMethod.IndexUpdateMethodUnspecified,
labels: {
string: "string",
},
location: "string",
metadata: "any",
metadataSchemaUri: "string",
project: "string",
});
type: google-native:aiplatform/v1beta1:Index
properties:
description: string
displayName: string
encryptionSpec:
kmsKeyName: string
etag: string
indexUpdateMethod: INDEX_UPDATE_METHOD_UNSPECIFIED
labels:
string: string
location: string
metadata: any
metadataSchemaUri: string
project: string
Index Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Index resource accepts the following input properties:
- Display
Name string - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Description string
- The description of the Index.
- Encryption
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Encryption Spec - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- Etag string
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- Index
Update Pulumi.Method Google Native. Aiplatform. V1Beta1. Index Index Update Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- Labels Dictionary<string, string>
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- Location string
- Metadata object
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- Metadata
Schema stringUri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- Project string
- Display
Name string - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Description string
- The description of the Index.
- Encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Args - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- Etag string
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- Index
Update IndexMethod Index Update Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- Labels map[string]string
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- Location string
- Metadata interface{}
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- Metadata
Schema stringUri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- Project string
- display_
name string - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- description string
- The description of the Index.
- encryption_
spec object - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- etag string
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- index_
update_ "INDEX_UPDATE_METHOD_UNSPECIFIED" | "BATCH_UPDATE" | "STREAM_UPDATE"method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- labels map(string)
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- location string
- metadata any
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- metadata_
schema_ stringuri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- project string
- display
Name String - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- description String
- The description of the Index.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- etag String
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- index
Update IndexMethod Index Update Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- labels Map<String,String>
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- location String
- metadata Object
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- metadata
Schema StringUri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- project String
- display
Name string - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- description string
- The description of the Index.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- etag string
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- index
Update IndexMethod Index Update Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- labels {[key: string]: string}
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- location string
- metadata any
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- metadata
Schema stringUri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- project string
- display_
name str - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- description str
- The description of the Index.
- encryption_
spec GoogleCloud Aiplatform V1beta1Encryption Spec Args - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- etag str
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- index_
update_ Indexmethod Index Update Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- labels Mapping[str, str]
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- location str
- metadata Any
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- metadata_
schema_ struri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- project str
- display
Name String - The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- description String
- The description of the Index.
- encryption
Spec Property Map - Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
- etag String
- Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- index
Update "INDEX_UPDATE_METHOD_UNSPECIFIED" | "BATCH_UPDATE" | "STREAM_UPDATE"Method - Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- labels Map<String>
- The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- location String
- metadata Any
- An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- metadata
Schema StringUri - Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:
- Create
Time string - Timestamp when this Index was created.
- Deployed
Indexes List<Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Deployed Index Ref Response> - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Stats Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Index Stats Response - Stats of the index resource.
- Name string
- The resource name of the Index.
- Update
Time string - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- Create
Time string - Timestamp when this Index was created.
- Deployed
Indexes []GoogleCloud Aiplatform V1beta1Deployed Index Ref Response - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Stats GoogleCloud Aiplatform V1beta1Index Stats Response - Stats of the index resource.
- Name string
- The resource name of the Index.
- Update
Time string - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- create_
time string - Timestamp when this Index was created.
- deployed_
indexes list(object) - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- id string
- The provider-assigned unique ID for this managed resource.
- index_
stats object - Stats of the index resource.
- name string
- The resource name of the Index.
- update_
time string - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- create
Time String - Timestamp when this Index was created.
- deployed
Indexes List<GoogleCloud Aiplatform V1beta1Deployed Index Ref Response> - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- id String
- The provider-assigned unique ID for this managed resource.
- index
Stats GoogleCloud Aiplatform V1beta1Index Stats Response - Stats of the index resource.
- name String
- The resource name of the Index.
- update
Time String - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- create
Time string - Timestamp when this Index was created.
- deployed
Indexes GoogleCloud Aiplatform V1beta1Deployed Index Ref Response[] - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- id string
- The provider-assigned unique ID for this managed resource.
- index
Stats GoogleCloud Aiplatform V1beta1Index Stats Response - Stats of the index resource.
- name string
- The resource name of the Index.
- update
Time string - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- create_
time str - Timestamp when this Index was created.
- deployed_
indexes Sequence[GoogleCloud Aiplatform V1beta1Deployed Index Ref Response] - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- id str
- The provider-assigned unique ID for this managed resource.
- index_
stats GoogleCloud Aiplatform V1beta1Index Stats Response - Stats of the index resource.
- name str
- The resource name of the Index.
- update_
time str - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
- create
Time String - Timestamp when this Index was created.
- deployed
Indexes List<Property Map> - The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
- id String
- The provider-assigned unique ID for this managed resource.
- index
Stats Property Map - Stats of the index resource.
- name String
- The resource name of the Index.
- update
Time String - Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
Look up Existing Index Resource
Get an existing Index 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>, opts?: CustomResourceOptions): Index@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Indexfunc GetIndex(ctx *Context, name string, id IDInput, state *IndexState, opts ...ResourceOption) (*Index, error)public static Index Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Index get(String name, Output<String> id, CustomResourceOptions options)resources: existingIndex: type: google-native:aiplatform/v1beta1:Index get: id: ${id}import {
to = google-native_aiplatform_v1beta1_index.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state IndexState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
GoogleCloudAiplatformV1beta1DeployedIndexRefResponse
Points to a DeployedIndex.
- Deployed
Index stringId - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- Index
Endpoint string - Immutable. A resource name of the IndexEndpoint.
- Deployed
Index stringId - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- Index
Endpoint string - Immutable. A resource name of the IndexEndpoint.
- deployed_
index_ stringid - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- index_
endpoint string - Immutable. A resource name of the IndexEndpoint.
- deployed
Index StringId - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- index
Endpoint String - Immutable. A resource name of the IndexEndpoint.
- deployed
Index stringId - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- index
Endpoint string - Immutable. A resource name of the IndexEndpoint.
- deployed_
index_ strid - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- index_
endpoint str - Immutable. A resource name of the IndexEndpoint.
- deployed
Index StringId - Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
- index
Endpoint String - Immutable. A resource name of the IndexEndpoint.
GoogleCloudAiplatformV1beta1EncryptionSpec, GoogleCloudAiplatformV1beta1EncryptionSpecArgs
Represents a customer-managed encryption key spec that can be applied to a top-level resource.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ stringname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ strname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Represents a customer-managed encryption key spec that can be applied to a top-level resource.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ stringname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ strname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the Index.
- int
- The number of shards in the Index.
- Vectors
Count string - The number of vectors in the Index.
- int
- The number of shards in the Index.
- Vectors
Count string - The number of vectors in the Index.
- number
- The number of shards in the Index.
- vectors_
count string - The number of vectors in the Index.
- Integer
- The number of shards in the Index.
- vectors
Count String - The number of vectors in the Index.
- number
- The number of shards in the Index.
- vectors
Count string - The number of vectors in the Index.
- int
- The number of shards in the Index.
- vectors_
count str - The number of vectors in the Index.
- Number
- The number of shards in the Index.
- vectors
Count String - The number of vectors in the Index.
IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
| Name | Value | Description |
|---|---|---|
| Index | INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
| Batch | BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
| Stream | STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Name | Value | Description |
|---|---|---|
| Index | INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
| Index | BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
| Index | STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Value | Description |
|---|---|
INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Name | Value | Description |
|---|---|---|
| Index | INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
| Batch | BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
| Stream | STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Name | Value | Description |
|---|---|---|
| Index | INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
| Batch | BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
| Stream | STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Name | Value | Description |
|---|---|---|
| INDEX_UPDATE_METHOD_UNSPECIFIED | INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
| BATCH_UPDATE | BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
| STREAM_UPDATE | STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
| Value | Description |
|---|---|
INDEX_UPDATE_METHOD_UNSPECIFIED | Should not be used. |
BATCH_UPDATE | BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update. |
STREAM_UPDATE | StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi