UNPKG

@pulumi/vault

Version:

A Pulumi package for creating and managing HashiCorp Vault cloud resources.

124 lines (123 loc) 4.48 kB
import * as pulumi from "@pulumi/pulumi"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as std from "@pulumi/std"; * import * as vault from "@pulumi/vault"; * * const github_apps = new vault.secrets.SyncGithubApps("github-apps", { * name: "gh-apps", * appId: appId, * privateKey: std.file({ * input: privatekeyFile, * }).then(invoke => invoke.result), * }); * ``` * * ## Import * * GitHub Apps Secrets sync configuration endpoint can be imported using the `name`, e.g. * * ```sh * $ pulumi import vault:secrets/syncGithubApps:SyncGithubApps gh github-apps * ``` */ export declare class SyncGithubApps extends pulumi.CustomResource { /** * Get an existing SyncGithubApps 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?: SyncGithubAppsState, opts?: pulumi.CustomResourceOptions): SyncGithubApps; /** * Returns true if the given object is an instance of SyncGithubApps. 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 SyncGithubApps; /** * The GitHub application ID. */ readonly appId: pulumi.Output<number>; /** * A fingerprint of a private key. */ readonly fingerprint: pulumi.Output<string>; /** * The user-defined name of the GitHub App configuration. */ readonly name: pulumi.Output<string>; /** * The namespace to provision the resource in. * The value should not contain leading or trailing forward slashes. * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace). */ readonly namespace: pulumi.Output<string | undefined>; /** * The content of a PEM formatted private key generated on GitHub for the app. */ readonly privateKey: pulumi.Output<string>; /** * Create a SyncGithubApps 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: SyncGithubAppsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SyncGithubApps resources. */ export interface SyncGithubAppsState { /** * The GitHub application ID. */ appId?: pulumi.Input<number>; /** * A fingerprint of a private key. */ fingerprint?: pulumi.Input<string>; /** * The user-defined name of the GitHub App configuration. */ name?: pulumi.Input<string>; /** * The namespace to provision the resource in. * The value should not contain leading or trailing forward slashes. * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace). */ namespace?: pulumi.Input<string>; /** * The content of a PEM formatted private key generated on GitHub for the app. */ privateKey?: pulumi.Input<string>; } /** * The set of arguments for constructing a SyncGithubApps resource. */ export interface SyncGithubAppsArgs { /** * The GitHub application ID. */ appId: pulumi.Input<number>; /** * The user-defined name of the GitHub App configuration. */ name?: pulumi.Input<string>; /** * The namespace to provision the resource in. * The value should not contain leading or trailing forward slashes. * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace). */ namespace?: pulumi.Input<string>; /** * The content of a PEM formatted private key generated on GitHub for the app. */ privateKey: pulumi.Input<string>; }