1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. secretmanager
  5. getSecretVersion
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.secretmanager.getSecretVersion

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    Get the value and metadata from a Secret Manager secret version. For more information see the official documentation datasource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const basic = gcp.secretmanager.getSecretVersion({
        secret: "my-secret",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    basic = gcp.secretmanager.get_secret_version(secret="my-secret")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/secretmanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := secretmanager.LookupSecretVersion(ctx, &secretmanager.LookupSecretVersionArgs{
    			Secret: "my-secret",
    		}, 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.SecretManager.GetSecretVersion.Invoke(new()
        {
            Secret = "my-secret",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.secretmanager.SecretmanagerFunctions;
    import com.pulumi.gcp.secretmanager.inputs.GetSecretVersionArgs;
    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 = SecretmanagerFunctions.getSecretVersion(GetSecretVersionArgs.builder()
                .secret("my-secret")
                .build());
    
        }
    }
    
    variables:
      basic:
        fn::invoke:
          Function: gcp:secretmanager:getSecretVersion
          Arguments:
            secret: my-secret
    

    Using getSecretVersion

    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 getSecretVersion(args: GetSecretVersionArgs, opts?: InvokeOptions): Promise<GetSecretVersionResult>
    function getSecretVersionOutput(args: GetSecretVersionOutputArgs, opts?: InvokeOptions): Output<GetSecretVersionResult>
    def get_secret_version(project: Optional[str] = None,
                           secret: Optional[str] = None,
                           version: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSecretVersionResult
    def get_secret_version_output(project: Optional[pulumi.Input[str]] = None,
                           secret: Optional[pulumi.Input[str]] = None,
                           version: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSecretVersionResult]
    func LookupSecretVersion(ctx *Context, args *LookupSecretVersionArgs, opts ...InvokeOption) (*LookupSecretVersionResult, error)
    func LookupSecretVersionOutput(ctx *Context, args *LookupSecretVersionOutputArgs, opts ...InvokeOption) LookupSecretVersionResultOutput

    > Note: This function is named LookupSecretVersion in the Go SDK.

    public static class GetSecretVersion 
    {
        public static Task<GetSecretVersionResult> InvokeAsync(GetSecretVersionArgs args, InvokeOptions? opts = null)
        public static Output<GetSecretVersionResult> Invoke(GetSecretVersionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecretVersionResult> getSecretVersion(GetSecretVersionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:secretmanager/getSecretVersion:getSecretVersion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Secret string
    The secret to get the secret version for.
    Project string
    The project to get the secret version for. If it is not provided, the provider project is used.
    Version string
    The version of the secret to get. If it is not provided, the latest version is retrieved.
    Secret string
    The secret to get the secret version for.
    Project string
    The project to get the secret version for. If it is not provided, the provider project is used.
    Version string
    The version of the secret to get. If it is not provided, the latest version is retrieved.
    secret String
    The secret to get the secret version for.
    project String
    The project to get the secret version for. If it is not provided, the provider project is used.
    version String
    The version of the secret to get. If it is not provided, the latest version is retrieved.
    secret string
    The secret to get the secret version for.
    project string
    The project to get the secret version for. If it is not provided, the provider project is used.
    version string
    The version of the secret to get. If it is not provided, the latest version is retrieved.
    secret str
    The secret to get the secret version for.
    project str
    The project to get the secret version for. If it is not provided, the provider project is used.
    version str
    The version of the secret to get. If it is not provided, the latest version is retrieved.
    secret String
    The secret to get the secret version for.
    project String
    The project to get the secret version for. If it is not provided, the provider project is used.
    version String
    The version of the secret to get. If it is not provided, the latest version is retrieved.

    getSecretVersion Result

    The following output properties are available:

    CreateTime string
    The time at which the Secret was created.
    DestroyTime string
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    Enabled bool
    True if the current state of the SecretVersion is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    Project string
    Secret string
    SecretData string
    The secret data. No larger than 64KiB.
    Version string
    CreateTime string
    The time at which the Secret was created.
    DestroyTime string
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    Enabled bool
    True if the current state of the SecretVersion is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    Project string
    Secret string
    SecretData string
    The secret data. No larger than 64KiB.
    Version string
    createTime String
    The time at which the Secret was created.
    destroyTime String
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    enabled Boolean
    True if the current state of the SecretVersion is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    project String
    secret String
    secretData String
    The secret data. No larger than 64KiB.
    version String
    createTime string
    The time at which the Secret was created.
    destroyTime string
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    enabled boolean
    True if the current state of the SecretVersion is enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    project string
    secret string
    secretData string
    The secret data. No larger than 64KiB.
    version string
    create_time str
    The time at which the Secret was created.
    destroy_time str
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    enabled bool
    True if the current state of the SecretVersion is enabled.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    project str
    secret str
    secret_data str
    The secret data. No larger than 64KiB.
    version str
    createTime String
    The time at which the Secret was created.
    destroyTime String
    The time at which the Secret was destroyed. Only present if state is DESTROYED.
    enabled Boolean
    True if the current state of the SecretVersion is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}
    project String
    secret String
    secretData String
    The secret data. No larger than 64KiB.
    version String

    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.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi