@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
101 lines (100 loc) • 4.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get the value and metadata from a Parameter Manager Parameter version with render payload data. For this datasource to work as expected, the principal of the parameter must be provided with the [Secret Manager Secret Accessor](https://cloud.google.com/secret-manager/docs/access-control#secretmanager.secretAccessor) role. For more information see the [official documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/overview) and [API](https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters.versions/render).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basic = gcp.parametermanager.getParameterVersionRender({
* parameter: "test-parameter",
* parameterVersionId: "test-parameter-version",
* });
* ```
*/
export declare function getParameterVersionRender(args: GetParameterVersionRenderArgs, opts?: pulumi.InvokeOptions): Promise<GetParameterVersionRenderResult>;
/**
* A collection of arguments for invoking getParameterVersionRender.
*/
export interface GetParameterVersionRenderArgs {
/**
* The Parameter for obtaining the Parameter Version.
* This can be either the reference of the parameter as in `projects/{{project}}/locations/global/parameters/{{parameter_id}}` or only the name of the parameter as in `{{parameter_id}}`.
*/
parameter: string;
/**
* The version of the parameter to get.
*/
parameterVersionId: string;
/**
* The project for retrieving the Parameter Version. If it's not specified,
* the provider project will be used.
*/
project?: string;
}
/**
* A collection of values returned by getParameterVersionRender.
*/
export interface GetParameterVersionRenderResult {
/**
* The current state of the Parameter Version.
*/
readonly disabled: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The resource name of the ParameterVersion. Format:
* `projects/{{project}}/locations/global/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
*/
readonly name: string;
readonly parameter: string;
/**
* The Parameter data.
*/
readonly parameterData: string;
readonly parameterVersionId: string;
readonly project: string;
/**
* The Rendered Parameter Data specifies that if you use `__REF__()` to reference a secret and the format is JSON or YAML, the placeholder `__REF__()` will be replaced with the actual secret value. However, if the format is UNFORMATTED, it will stay the same as the original `parameterData`.
*/
readonly renderedParameterData: string;
}
/**
* Get the value and metadata from a Parameter Manager Parameter version with render payload data. For this datasource to work as expected, the principal of the parameter must be provided with the [Secret Manager Secret Accessor](https://cloud.google.com/secret-manager/docs/access-control#secretmanager.secretAccessor) role. For more information see the [official documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/overview) and [API](https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters.versions/render).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basic = gcp.parametermanager.getParameterVersionRender({
* parameter: "test-parameter",
* parameterVersionId: "test-parameter-version",
* });
* ```
*/
export declare function getParameterVersionRenderOutput(args: GetParameterVersionRenderOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetParameterVersionRenderResult>;
/**
* A collection of arguments for invoking getParameterVersionRender.
*/
export interface GetParameterVersionRenderOutputArgs {
/**
* The Parameter for obtaining the Parameter Version.
* This can be either the reference of the parameter as in `projects/{{project}}/locations/global/parameters/{{parameter_id}}` or only the name of the parameter as in `{{parameter_id}}`.
*/
parameter: pulumi.Input<string>;
/**
* The version of the parameter to get.
*/
parameterVersionId: pulumi.Input<string>;
/**
* The project for retrieving the Parameter Version. If it's not specified,
* the provider project will be used.
*/
project?: pulumi.Input<string>;
}