import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A resource represents a Dataform Git repository * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * To get more information about Repository, see: * * * [API documentation](https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories) * * How-to Guides * * [Official Documentation](https://cloud.google.com/dataform/docs/) * * ## Example Usage * * ### Dataform Repository * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const secret = new gcp.secretmanager.Secret("secret", { * secretId: "my-secret", * replication: { * auto: {}, * }, * }); * const secretVersion = new gcp.secretmanager.SecretVersion("secret_version", { * secret: secret.id, * secretData: "secret-data", * }); * const keyring = new gcp.kms.KeyRing("keyring", { * name: "example-key-ring", * location: "us-central1", * }); * const exampleKey = new gcp.kms.CryptoKey("example_key", { * name: "example-crypto-key-name", * keyRing: keyring.id, * }); * const cryptoKeyBinding = new gcp.kms.CryptoKeyIAMBinding("crypto_key_binding", { * cryptoKeyId: exampleKey.id, * role: "roles/cloudkms.cryptoKeyEncrypterDecrypter", * members: [`serviceAccount:service-${project.number}@gcp-sa-dataform.iam.gserviceaccount.com`], * }); * const dataformRepository = new gcp.dataform.Repository("dataform_repository", { * name: "dataform_repository", * displayName: "dataform_repository", * npmrcEnvironmentVariablesSecretVersion: secretVersion.id, * kmsKeyName: exampleKey.id, * deletionPolicy: "FORCE", * labels: { * label_foo1: "label-bar1", * }, * gitRemoteSettings: { * url: "https://github.com/OWNER/REPOSITORY.git", * defaultBranch: "main", * authenticationTokenSecretVersion: secretVersion.id, * }, * workspaceCompilationOverrides: { * defaultDatabase: "database", * schemaSuffix: "_suffix", * tablePrefix: "prefix_", * }, * }, { * dependsOn: [cryptoKeyBinding], * }); * ``` * * ## Import * * Repository can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{region}}/repositories/{{name}}` * * `{{project}}/{{region}}/{{name}}` * * `{{region}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, Repository can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:dataform/repository:Repository default projects/{{project}}/locations/{{region}}/repositories/{{name}} * $ pulumi import gcp:dataform/repository:Repository default {{project}}/{{region}}/{{name}} * $ pulumi import gcp:dataform/repository:Repository default {{region}}/{{name}} * $ pulumi import gcp:dataform/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, 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; /** * Policy to control how the repository and its child resources are deleted. * When set to `FORCE`, any child resources of this repository will also be deleted. * * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * * Possible values: `DELETE`, `FORCE`, 'PREVENT', 'ABANDON'. Defaults to `DELETE`. */ readonly deletionPolicy: pulumi.Output; /** * Optional. The repository's user-friendly name. */ readonly displayName: pulumi.Output; /** * 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; }>; /** * Optional. If set, configures this repository to be linked to a Git remote. * Structure is documented below. */ readonly gitRemoteSettings: pulumi.Output; /** * Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. * It is not possible to add or update the encryption key after the repository is created. Example projects/[kmsProjectId]/locations/[region]/keyRings/[keyRegion]/cryptoKeys/[key] */ readonly kmsKeyName: pulumi.Output; /** * Optional. Repository user labels. * An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. * * **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 repository's name. */ readonly name: pulumi.Output; /** * Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format projects/*/secrets/*/versions/*. The file itself must be in a JSON format. */ readonly npmrcEnvironmentVariablesSecretVersion: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * A reference to the region */ readonly region: pulumi.Output; /** * The service account to run workflow invocations under. */ readonly serviceAccount: pulumi.Output; /** * If set, fields of workspaceCompilationOverrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. * Structure is documented below. */ readonly workspaceCompilationOverrides: pulumi.Output; /** * 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 { /** * Policy to control how the repository and its child resources are deleted. * When set to `FORCE`, any child resources of this repository will also be deleted. * * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * * Possible values: `DELETE`, `FORCE`, 'PREVENT', 'ABANDON'. Defaults to `DELETE`. */ deletionPolicy?: pulumi.Input; /** * Optional. The repository's user-friendly name. */ displayName?: pulumi.Input; /** * 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; } | undefined>; /** * Optional. If set, configures this repository to be linked to a Git remote. * Structure is documented below. */ gitRemoteSettings?: pulumi.Input; /** * Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. * It is not possible to add or update the encryption key after the repository is created. Example projects/[kmsProjectId]/locations/[region]/keyRings/[keyRegion]/cryptoKeys/[key] */ kmsKeyName?: pulumi.Input; /** * Optional. Repository user labels. * An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. * * **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; } | undefined>; /** * The repository's name. */ name?: pulumi.Input; /** * Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format projects/*/secrets/*/versions/*. The file itself must be in a JSON format. */ npmrcEnvironmentVariablesSecretVersion?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * A reference to the region */ region?: pulumi.Input; /** * The service account to run workflow invocations under. */ serviceAccount?: pulumi.Input; /** * If set, fields of workspaceCompilationOverrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. * Structure is documented below. */ workspaceCompilationOverrides?: pulumi.Input; } /** * The set of arguments for constructing a Repository resource. */ export interface RepositoryArgs { /** * Policy to control how the repository and its child resources are deleted. * When set to `FORCE`, any child resources of this repository will also be deleted. * * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * * Possible values: `DELETE`, `FORCE`, 'PREVENT', 'ABANDON'. Defaults to `DELETE`. */ deletionPolicy?: pulumi.Input; /** * Optional. The repository's user-friendly name. */ displayName?: pulumi.Input; /** * Optional. If set, configures this repository to be linked to a Git remote. * Structure is documented below. */ gitRemoteSettings?: pulumi.Input; /** * Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. * It is not possible to add or update the encryption key after the repository is created. Example projects/[kmsProjectId]/locations/[region]/keyRings/[keyRegion]/cryptoKeys/[key] */ kmsKeyName?: pulumi.Input; /** * Optional. Repository user labels. * An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. * * **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; } | undefined>; /** * The repository's name. */ name?: pulumi.Input; /** * Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format projects/*/secrets/*/versions/*. The file itself must be in a JSON format. */ npmrcEnvironmentVariablesSecretVersion?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * A reference to the region */ region?: pulumi.Input; /** * The service account to run workflow invocations under. */ serviceAccount?: pulumi.Input; /** * If set, fields of workspaceCompilationOverrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. * Structure is documented below. */ workspaceCompilationOverrides?: pulumi.Input; } //# sourceMappingURL=repository.d.ts.map