@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
277 lines (276 loc) • 9.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Repositories store source code. It supports all Git SCM client commands and has built-in pull requests and issue tracking. Both HTTPS and SSH authentication are supported.
*
* To get more information about Repository, see:
*
* * [API documentation](https://cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.repositories)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/secure-source-manager/docs/overview)
*
* ## Example Usage
*
* ### Secure Source Manager Repository Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const instance = new gcp.securesourcemanager.Instance("instance", {
* location: "us-central1",
* instanceId: "my-instance",
* deletionPolicy: "PREVENT",
* });
* const _default = new gcp.securesourcemanager.Repository("default", {
* location: "us-central1",
* repositoryId: "my-repository",
* instance: instance.name,
* deletionPolicy: "PREVENT",
* });
* ```
* ### Secure Source Manager Repository Initial Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const instance = new gcp.securesourcemanager.Instance("instance", {
* location: "us-central1",
* instanceId: "my-instance",
* deletionPolicy: "PREVENT",
* });
* const _default = new gcp.securesourcemanager.Repository("default", {
* location: "us-central1",
* repositoryId: "my-repository",
* instance: instance.name,
* description: "This is a test repository",
* initialConfig: {
* defaultBranch: "main",
* gitignores: ["python"],
* license: "mit",
* readme: "default",
* },
* deletionPolicy: "PREVENT",
* });
* ```
*
* ## Import
*
* Repository can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}`
*
* * `{{project}}/{{location}}/{{repository_id}}`
*
* * `{{location}}/{{repository_id}}`
*
* * `{{repository_id}}`
*
* When using the `pulumi import` command, Repository can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:securesourcemanager/repository:Repository default projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securesourcemanager/repository:Repository default {{project}}/{{location}}/{{repository_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securesourcemanager/repository:Repository default {{location}}/{{repository_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securesourcemanager/repository:Repository default {{repository_id}}
* ```
*/
export declare class Repository extends pulumi.CustomResource {
/**
* Get an existing Repository 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?: RepositoryState, opts?: pulumi.CustomResourceOptions): Repository;
/**
* Returns true if the given object is an instance of Repository. 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 Repository;
/**
* Time the repository was created in UTC.
*/
readonly createTime: pulumi.Output<string>;
/**
* The deletion policy for the repository. Setting `ABANDON` allows the resource
* to be abandoned, rather than deleted. Setting `DELETE` deletes the resource
* and all its contents. Setting `PREVENT` prevents the resource from accidental deletion
* by erroring out during plan.
* Default is `PREVENT`. Possible values are:
* * DELETE
* * PREVENT
* * ABANDON
*/
readonly deletionPolicy: pulumi.Output<string | undefined>;
/**
* Description of the repository, which cannot exceed 500 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Initial configurations for the repository.
* Structure is documented below.
*/
readonly initialConfig: pulumi.Output<outputs.securesourcemanager.RepositoryInitialConfig | undefined>;
/**
* The name of the instance in which the repository is hosted.
*/
readonly instance: pulumi.Output<string>;
/**
* The location for the Repository.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name for the Repository.
*/
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 ID for the Repository.
*/
readonly repositoryId: pulumi.Output<string>;
/**
* Unique identifier of the repository.
*/
readonly uid: pulumi.Output<string>;
/**
* Time the repository was updated in UTC.
*/
readonly updateTime: pulumi.Output<string>;
/**
* URIs for the repository.
* Structure is documented below.
*/
readonly uris: pulumi.Output<outputs.securesourcemanager.RepositoryUri[]>;
/**
* Create a Repository 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: RepositoryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Repository resources.
*/
export interface RepositoryState {
/**
* Time the repository was created in UTC.
*/
createTime?: pulumi.Input<string>;
/**
* The deletion policy for the repository. Setting `ABANDON` allows the resource
* to be abandoned, rather than deleted. Setting `DELETE` deletes the resource
* and all its contents. Setting `PREVENT` prevents the resource from accidental deletion
* by erroring out during plan.
* Default is `PREVENT`. Possible values are:
* * DELETE
* * PREVENT
* * ABANDON
*/
deletionPolicy?: pulumi.Input<string>;
/**
* Description of the repository, which cannot exceed 500 characters.
*/
description?: pulumi.Input<string>;
/**
* Initial configurations for the repository.
* Structure is documented below.
*/
initialConfig?: pulumi.Input<inputs.securesourcemanager.RepositoryInitialConfig>;
/**
* The name of the instance in which the repository is hosted.
*/
instance?: pulumi.Input<string>;
/**
* The location for the Repository.
*/
location?: pulumi.Input<string>;
/**
* The resource name for the Repository.
*/
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 ID for the Repository.
*/
repositoryId?: pulumi.Input<string>;
/**
* Unique identifier of the repository.
*/
uid?: pulumi.Input<string>;
/**
* Time the repository was updated in UTC.
*/
updateTime?: pulumi.Input<string>;
/**
* URIs for the repository.
* Structure is documented below.
*/
uris?: pulumi.Input<pulumi.Input<inputs.securesourcemanager.RepositoryUri>[]>;
}
/**
* The set of arguments for constructing a Repository resource.
*/
export interface RepositoryArgs {
/**
* The deletion policy for the repository. Setting `ABANDON` allows the resource
* to be abandoned, rather than deleted. Setting `DELETE` deletes the resource
* and all its contents. Setting `PREVENT` prevents the resource from accidental deletion
* by erroring out during plan.
* Default is `PREVENT`. Possible values are:
* * DELETE
* * PREVENT
* * ABANDON
*/
deletionPolicy?: pulumi.Input<string>;
/**
* Description of the repository, which cannot exceed 500 characters.
*/
description?: pulumi.Input<string>;
/**
* Initial configurations for the repository.
* Structure is documented below.
*/
initialConfig?: pulumi.Input<inputs.securesourcemanager.RepositoryInitialConfig>;
/**
* The name of the instance in which the repository is hosted.
*/
instance: pulumi.Input<string>;
/**
* The location for the Repository.
*/
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>;
/**
* The ID for the Repository.
*/
repositoryId: pulumi.Input<string>;
}