@pulumi/gcp/secretmanager/getRegionalSecretVersion.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * subcategory: "Secret Manager"
 * description: |-
 *   Get a Secret Manager regional secret's version.
 * ---
 *
 * Get the value and metadata from a Secret Manager regional secret version. For more information see the [official documentation](https://cloud.google.com/secret-manager/docs/regional-secrets-overview) and [API](https://cloud.google.com/secret-manager/docs/reference/rest/v1/projects.locations.secrets.versions). If you don't need the metadata (i.e., if you want to use a more limited role to access the regional secret version only), see also the gcp.secretmanager.getRegionalSecretVersionAccess datasource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basic = gcp.secretmanager.getRegionalSecretVersion({
 *     secret: "my-secret",
 *     location: "us-central1",
 * });
 * ```
 */
export declare function getRegionalSecretVersion(args: GetRegionalSecretVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetRegionalSecretVersionResult>;
/**
 * A collection of arguments for invoking getRegionalSecretVersion.
 */
export interface GetRegionalSecretVersionArgs {
    /**
     * If set to 'true', the secret data is
     * expected to be base64-encoded string.
     */
    isSecretDataBase64?: boolean;
    /**
     * Location of Secret Manager regional secret resource.
     * It must be provided when the `secret` field provided consists of only the name of the regional secret.
     */
    location?: string;
    /**
     * The project to get the secret version for. If it
     * is not provided, the provider project is used.
     */
    project?: string;
    /**
     * The regional secret to get the secret version for.
     * This can be either the reference of the regional secret as in `projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}` or only the name of the regional secret as in `{{secret_id}}`. If only the name of the regional secret is provided, the location must also be provided.
     */
    secret: string;
    /**
     * The version of the regional secret to get. If it
     * is not provided, the latest version is retrieved.
     */
    version?: string;
}
/**
 * A collection of values returned by getRegionalSecretVersion.
 */
export interface GetRegionalSecretVersionResult {
    /**
     * The time at which the regional secret was created.
     */
    readonly createTime: string;
    /**
     * The customer-managed encryption configuration of the regional secret. Structure is documented below.
     */
    readonly customerManagedEncryptions: outputs.secretmanager.GetRegionalSecretVersionCustomerManagedEncryption[];
    /**
     * The time at which the regional secret was destroyed. Only present if state is DESTROYED.
     */
    readonly destroyTime: string;
    /**
     * True if the current state of the regional SecretVersion is enabled.
     */
    readonly enabled: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly isSecretDataBase64?: boolean;
    readonly location: string;
    /**
     * The resource name of the regional SecretVersion. Format:
     * `projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}/versions/{{version}}`
     */
    readonly name: string;
    readonly project: string;
    readonly secret: string;
    /**
     * The secret data. No larger than 64KiB.
     */
    readonly secretData: string;
    readonly version: string;
}
/**
 * subcategory: "Secret Manager"
 * description: |-
 *   Get a Secret Manager regional secret's version.
 * ---
 *
 * Get the value and metadata from a Secret Manager regional secret version. For more information see the [official documentation](https://cloud.google.com/secret-manager/docs/regional-secrets-overview) and [API](https://cloud.google.com/secret-manager/docs/reference/rest/v1/projects.locations.secrets.versions). If you don't need the metadata (i.e., if you want to use a more limited role to access the regional secret version only), see also the gcp.secretmanager.getRegionalSecretVersionAccess datasource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basic = gcp.secretmanager.getRegionalSecretVersion({
 *     secret: "my-secret",
 *     location: "us-central1",
 * });
 * ```
 */
export declare function getRegionalSecretVersionOutput(args: GetRegionalSecretVersionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegionalSecretVersionResult>;
/**
 * A collection of arguments for invoking getRegionalSecretVersion.
 */
export interface GetRegionalSecretVersionOutputArgs {
    /**
     * If set to 'true', the secret data is
     * expected to be base64-encoded string.
     */
    isSecretDataBase64?: pulumi.Input<boolean>;
    /**
     * Location of Secret Manager regional secret resource.
     * It must be provided when the `secret` field provided consists of only the name of the regional secret.
     */
    location?: pulumi.Input<string>;
    /**
     * The project to get the secret version for. If it
     * is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The regional secret to get the secret version for.
     * This can be either the reference of the regional secret as in `projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}` or only the name of the regional secret as in `{{secret_id}}`. If only the name of the regional secret is provided, the location must also be provided.
     */
    secret: pulumi.Input<string>;
    /**
     * The version of the regional secret to get. If it
     * is not provided, the latest version is retrieved.
     */
    version?: pulumi.Input<string>;
}