@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
173 lines (172 loc) • 6.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A repository (or repo) is a Git repository storing versioned source content.
*
* To get more information about Repository, see:
*
* * [API documentation](https://cloud.google.com/source-repositories/docs/reference/rest/v1/projects.repos)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/source-repositories/)
*
* ## Example Usage
*
* ### Sourcerepo Repository Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_repo = new gcp.sourcerepo.Repository("my-repo", {name: "my/repository"});
* ```
* ### Sourcerepo Repository Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testAccount = new gcp.serviceaccount.Account("test_account", {
* accountId: "my-account",
* displayName: "Test Service Account",
* });
* const topic = new gcp.pubsub.Topic("topic", {name: "my-topic"});
* const my_repo = new gcp.sourcerepo.Repository("my-repo", {
* name: "my-repository",
* pubsubConfigs: [{
* topic: topic.id,
* messageFormat: "JSON",
* serviceAccountEmail: testAccount.email,
* }],
* });
* ```
*
* ## Import
*
* Repository can be imported using any of these accepted formats:
*
* * `projects/{{project}}/repos/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, Repository can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:sourcerepo/repository:Repository default projects/{{project}}/repos/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:sourcerepo/repository:Repository default {{name}}
* ```
*/
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;
/**
* If set to true, skip repository creation if a repository with the same name already exists.
*/
readonly createIgnoreAlreadyExists: pulumi.Output<boolean | undefined>;
/**
* Resource name of the repository, of the form `{{repo}}`.
* The repo name may contain slashes. eg, `name/with/slash`
*/
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>;
/**
* How this repository publishes a change in the repository through Cloud Pub/Sub.
* Keyed by the topic names.
* Structure is documented below.
*/
readonly pubsubConfigs: pulumi.Output<outputs.sourcerepo.RepositoryPubsubConfig[] | undefined>;
/**
* The disk usage of the repo, in bytes.
*/
readonly size: pulumi.Output<number>;
/**
* URL to clone the repository from Google Cloud Source Repositories.
*/
readonly url: pulumi.Output<string>;
/**
* 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 {
/**
* If set to true, skip repository creation if a repository with the same name already exists.
*/
createIgnoreAlreadyExists?: pulumi.Input<boolean>;
/**
* Resource name of the repository, of the form `{{repo}}`.
* The repo name may contain slashes. eg, `name/with/slash`
*/
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>;
/**
* How this repository publishes a change in the repository through Cloud Pub/Sub.
* Keyed by the topic names.
* Structure is documented below.
*/
pubsubConfigs?: pulumi.Input<pulumi.Input<inputs.sourcerepo.RepositoryPubsubConfig>[]>;
/**
* The disk usage of the repo, in bytes.
*/
size?: pulumi.Input<number>;
/**
* URL to clone the repository from Google Cloud Source Repositories.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Repository resource.
*/
export interface RepositoryArgs {
/**
* If set to true, skip repository creation if a repository with the same name already exists.
*/
createIgnoreAlreadyExists?: pulumi.Input<boolean>;
/**
* Resource name of the repository, of the form `{{repo}}`.
* The repo name may contain slashes. eg, `name/with/slash`
*/
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>;
/**
* How this repository publishes a change in the repository through Cloud Pub/Sub.
* Keyed by the topic names.
* Structure is documented below.
*/
pubsubConfigs?: pulumi.Input<pulumi.Input<inputs.sourcerepo.RepositoryPubsubConfig>[]>;
}