gcp.parametermanager.getRegionalParameterVersionRender
Explore with Pulumi AI
Get the value and metadata from a Parameter Manager Regional Parameter version with rendered payload data. For this datasource to work as expected, the principal of the parameter must be provided with the Secret Manager Secret Accessor role. For more information see the official documentation and API.
Warning: To use this data source, we must grant the
Secret Manager Secret Accessor
role to the principal of the parameter. Please note that it can take up to 7 minutes for the role to take effect. Hence, we might need to wait approximately 7 minutes after grantingSecret Manager Secret Accessor
role to the principal of the parameter. For more information see the access change propagation documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = gcp.parametermanager.getRegionalParameterVersionRender({
parameter: "test-regional-parameter",
parameterVersionId: "test-regional-parameter-version",
location: "us-central1",
});
import pulumi
import pulumi_gcp as gcp
basic = gcp.parametermanager.get_regional_parameter_version_render(parameter="test-regional-parameter",
parameter_version_id="test-regional-parameter-version",
location="us-central1")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/parametermanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := parametermanager.GetRegionalParameterVersionRender(ctx, ¶metermanager.GetRegionalParameterVersionRenderArgs{
Parameter: "test-regional-parameter",
ParameterVersionId: "test-regional-parameter-version",
Location: pulumi.StringRef("us-central1"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var basic = Gcp.ParameterManager.GetRegionalParameterVersionRender.Invoke(new()
{
Parameter = "test-regional-parameter",
ParameterVersionId = "test-regional-parameter-version",
Location = "us-central1",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.parametermanager.ParametermanagerFunctions;
import com.pulumi.gcp.parametermanager.inputs.GetRegionalParameterVersionRenderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var basic = ParametermanagerFunctions.getRegionalParameterVersionRender(GetRegionalParameterVersionRenderArgs.builder()
.parameter("test-regional-parameter")
.parameterVersionId("test-regional-parameter-version")
.location("us-central1")
.build());
}
}
variables:
basic:
fn::invoke:
function: gcp:parametermanager:getRegionalParameterVersionRender
arguments:
parameter: test-regional-parameter
parameterVersionId: test-regional-parameter-version
location: us-central1
Using getRegionalParameterVersionRender
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRegionalParameterVersionRender(args: GetRegionalParameterVersionRenderArgs, opts?: InvokeOptions): Promise<GetRegionalParameterVersionRenderResult>
function getRegionalParameterVersionRenderOutput(args: GetRegionalParameterVersionRenderOutputArgs, opts?: InvokeOptions): Output<GetRegionalParameterVersionRenderResult>
def get_regional_parameter_version_render(location: Optional[str] = None,
parameter: Optional[str] = None,
parameter_version_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRegionalParameterVersionRenderResult
def get_regional_parameter_version_render_output(location: Optional[pulumi.Input[str]] = None,
parameter: Optional[pulumi.Input[str]] = None,
parameter_version_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRegionalParameterVersionRenderResult]
func GetRegionalParameterVersionRender(ctx *Context, args *GetRegionalParameterVersionRenderArgs, opts ...InvokeOption) (*GetRegionalParameterVersionRenderResult, error)
func GetRegionalParameterVersionRenderOutput(ctx *Context, args *GetRegionalParameterVersionRenderOutputArgs, opts ...InvokeOption) GetRegionalParameterVersionRenderResultOutput
> Note: This function is named GetRegionalParameterVersionRender
in the Go SDK.
public static class GetRegionalParameterVersionRender
{
public static Task<GetRegionalParameterVersionRenderResult> InvokeAsync(GetRegionalParameterVersionRenderArgs args, InvokeOptions? opts = null)
public static Output<GetRegionalParameterVersionRenderResult> Invoke(GetRegionalParameterVersionRenderInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRegionalParameterVersionRenderResult> getRegionalParameterVersionRender(GetRegionalParameterVersionRenderArgs args, InvokeOptions options)
public static Output<GetRegionalParameterVersionRenderResult> getRegionalParameterVersionRender(GetRegionalParameterVersionRenderArgs args, InvokeOptions options)
fn::invoke:
function: gcp:parametermanager/getRegionalParameterVersionRender:getRegionalParameterVersionRender
arguments:
# arguments dictionary
The following arguments are supported:
- Parameter string
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - Parameter
Version stringId - The version of the regional parameter to get.
- Location string
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - Project string
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
- Parameter string
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - Parameter
Version stringId - The version of the regional parameter to get.
- Location string
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - Project string
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
- parameter String
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - parameter
Version StringId - The version of the regional parameter to get.
- location String
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - project String
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
- parameter string
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - parameter
Version stringId - The version of the regional parameter to get.
- location string
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - project string
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
- parameter str
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - parameter_
version_ strid - The version of the regional parameter to get.
- location str
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - project str
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
- parameter String
- The Parameter for obtaining the Regional Parameter Version.
This can be either the reference of the parameter as in
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
or only the name of the parameter as in{{parameter_id}}
. - parameter
Version StringId - The version of the regional parameter to get.
- location String
- Location of Parameter Manager regional Parameter resource.
It must be provided when the
parameter
field provided consists of only the name of the regional parameter. - project String
- The project for retrieving the Regional Parameter Version. If it's not specified, the provider project will be used.
getRegionalParameterVersionRender Result
The following output properties are available:
- Disabled bool
- The current state of the Regional Parameter Version.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- Name string
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- Parameter string
- Parameter
Data string - The Parameter data.
- Parameter
Version stringId - Project string
- Rendered
Parameter stringData - 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 originalparameter_data
.
- Disabled bool
- The current state of the Regional Parameter Version.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- Name string
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- Parameter string
- Parameter
Data string - The Parameter data.
- Parameter
Version stringId - Project string
- Rendered
Parameter stringData - 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 originalparameter_data
.
- disabled Boolean
- The current state of the Regional Parameter Version.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- name String
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- parameter String
- parameter
Data String - The Parameter data.
- parameter
Version StringId - project String
- rendered
Parameter StringData - 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 originalparameter_data
.
- disabled boolean
- The current state of the Regional Parameter Version.
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- name string
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- parameter string
- parameter
Data string - The Parameter data.
- parameter
Version stringId - project string
- rendered
Parameter stringData - 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 originalparameter_data
.
- disabled bool
- The current state of the Regional Parameter Version.
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- name str
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- parameter str
- parameter_
data str - The Parameter data.
- parameter_
version_ strid - project str
- rendered_
parameter_ strdata - 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 originalparameter_data
.
- disabled Boolean
- The current state of the Regional Parameter Version.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- name String
- The resource name of the RegionalParameterVersion. Format:
projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
- parameter String
- parameter
Data String - The Parameter data.
- parameter
Version StringId - project String
- rendered
Parameter StringData - 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 originalparameter_data
.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.