@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
235 lines (234 loc) • 9.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The resource for managing Code Repository Index for Gemini Code Assist.
*
* To get more information about CodeRepositoryIndex, see:
*
* * [API documentation](https://cloud.google.com/gemini/docs/api/reference/rest/v1/projects.locations.codeRepositoryIndexes)
* * How-to Guides
* * [Gemini Code Assist overview](https://cloud.google.com/gemini/docs/codeassist/overview)
*
* ## Example Usage
*
* ### Gemini Code Repository Index Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.gemini.CodeRepositoryIndex("example", {
* location: "us-central1",
* codeRepositoryIndexId: "code-repository-index-example",
* kmsKey: "projects/projectExample/locations/locationExample/keyRings/keyRingExample/cryptoKeys/cryptoKeyExample",
* });
* ```
*
* ## Import
*
* CodeRepositoryIndex can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/codeRepositoryIndexes/{{code_repository_index_id}}`
*
* * `{{project}}/{{location}}/{{code_repository_index_id}}`
*
* * `{{location}}/{{code_repository_index_id}}`
*
* When using the `pulumi import` command, CodeRepositoryIndex can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gemini/codeRepositoryIndex:CodeRepositoryIndex default projects/{{project}}/locations/{{location}}/codeRepositoryIndexes/{{code_repository_index_id}}
* ```
*
* ```sh
* $ pulumi import gcp:gemini/codeRepositoryIndex:CodeRepositoryIndex default {{project}}/{{location}}/{{code_repository_index_id}}
* ```
*
* ```sh
* $ pulumi import gcp:gemini/codeRepositoryIndex:CodeRepositoryIndex default {{location}}/{{code_repository_index_id}}
* ```
*/
export declare class CodeRepositoryIndex extends pulumi.CustomResource {
/**
* Get an existing CodeRepositoryIndex resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CodeRepositoryIndexState, opts?: pulumi.CustomResourceOptions): CodeRepositoryIndex;
/**
* Returns true if the given object is an instance of CodeRepositoryIndex. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CodeRepositoryIndex;
/**
* Required. Id of the Code Repository Index.
*/
readonly codeRepositoryIndexId: pulumi.Output<string>;
/**
* Output only. Create time stamp.
*/
readonly createTime: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* If set to true, will allow deletion of the CodeRepositoryIndex even if there are existing RepositoryGroups for the resource. These RepositoryGroups will also be deleted.
*/
readonly forceDestroy: pulumi.Output<boolean | undefined>;
/**
* Optional. Immutable. Customer-managed encryption key name, in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
*/
readonly kmsKey: pulumi.Output<string | undefined>;
/**
* Optional. Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The location of the Code Repository Index, for example `us-central1`.
*/
readonly location: pulumi.Output<string>;
/**
* Immutable. Identifier. Name of Code Repository Index.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Output only. Code Repository Index instance State.
* Possible values are: `STATE_UNSPECIFIED`, `CREATING`, `ACTIVE`, `DELETING`, `SUSPENDED`.
*/
readonly state: pulumi.Output<string>;
/**
* Output only. Update time stamp.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a CodeRepositoryIndex resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CodeRepositoryIndexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CodeRepositoryIndex resources.
*/
export interface CodeRepositoryIndexState {
/**
* Required. Id of the Code Repository Index.
*/
codeRepositoryIndexId?: pulumi.Input<string>;
/**
* Output only. Create time stamp.
*/
createTime?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* If set to true, will allow deletion of the CodeRepositoryIndex even if there are existing RepositoryGroups for the resource. These RepositoryGroups will also be deleted.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* Optional. Immutable. Customer-managed encryption key name, in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
*/
kmsKey?: pulumi.Input<string>;
/**
* Optional. Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The location of the Code Repository Index, for example `us-central1`.
*/
location?: pulumi.Input<string>;
/**
* Immutable. Identifier. Name of Code Repository Index.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Output only. Code Repository Index instance State.
* Possible values are: `STATE_UNSPECIFIED`, `CREATING`, `ACTIVE`, `DELETING`, `SUSPENDED`.
*/
state?: pulumi.Input<string>;
/**
* Output only. Update time stamp.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CodeRepositoryIndex resource.
*/
export interface CodeRepositoryIndexArgs {
/**
* Required. Id of the Code Repository Index.
*/
codeRepositoryIndexId: pulumi.Input<string>;
/**
* If set to true, will allow deletion of the CodeRepositoryIndex even if there are existing RepositoryGroups for the resource. These RepositoryGroups will also be deleted.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* Optional. Immutable. Customer-managed encryption key name, in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
*/
kmsKey?: pulumi.Input<string>;
/**
* Optional. Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The location of the Code Repository Index, for example `us-central1`.
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}