gcp.secretmanager.getRegionalSecret

Google Cloud v9.15.0, Mar 12 26

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const secretDatasource = gcp.secretmanager.getRegionalSecret({
    secretId: "secretname",
    location: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

secret_datasource = gcp.secretmanager.get_regional_secret(secret_id="secretname",
    location="us-central1")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/secretmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secretmanager.LookupRegionalSecret(ctx, &secretmanager.LookupRegionalSecretArgs{
			SecretId: "secretname",
			Location: "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 secretDatasource = Gcp.SecretManager.GetRegionalSecret.Invoke(new()
    {
        SecretId = "secretname",
        Location = "us-central1",
    });

});

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.GetRegionalSecretArgs;
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 secretDatasource = SecretmanagerFunctions.getRegionalSecret(GetRegionalSecretArgs.builder()
            .secretId("secretname")
            .location("us-central1")
            .build());

    }
}

variables:
  secretDatasource:
    fn::invoke:
      function: gcp:secretmanager:getRegionalSecret
      arguments:
        secretId: secretname
        location: us-central1

Using getRegionalSecret

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 getRegionalSecret(args: GetRegionalSecretArgs, opts?: InvokeOptions): Promise<GetRegionalSecretResult>
function getRegionalSecretOutput(args: GetRegionalSecretOutputArgs, opts?: InvokeOptions): Output<GetRegionalSecretResult>

def get_regional_secret(location: Optional[str] = None,
                        project: Optional[str] = None,
                        secret_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRegionalSecretResult
def get_regional_secret_output(location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        secret_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRegionalSecretResult]

func LookupRegionalSecret(ctx *Context, args *LookupRegionalSecretArgs, opts ...InvokeOption) (*LookupRegionalSecretResult, error)
func LookupRegionalSecretOutput(ctx *Context, args *LookupRegionalSecretOutputArgs, opts ...InvokeOption) LookupRegionalSecretResultOutput

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

public static class GetRegionalSecret 
{
    public static Task<GetRegionalSecretResult> InvokeAsync(GetRegionalSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionalSecretResult> Invoke(GetRegionalSecretInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRegionalSecretResult> getRegionalSecret(GetRegionalSecretArgs args, InvokeOptions options)
public static Output<GetRegionalSecretResult> getRegionalSecret(GetRegionalSecretArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:secretmanager/getRegionalSecret:getRegionalSecret
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string: The location of the regional secret. eg us-central1
SecretId string: The name of the regional secret.
Project string: The ID of the project in which the resource belongs.

Location string: The location of the regional secret. eg us-central1
SecretId string: The name of the regional secret.
Project string: The ID of the project in which the resource belongs.

location String: The location of the regional secret. eg us-central1
secretId String: The name of the regional secret.
project String: The ID of the project in which the resource belongs.

location string: The location of the regional secret. eg us-central1
secretId string: The name of the regional secret.
project string: The ID of the project in which the resource belongs.

location str: The location of the regional secret. eg us-central1
secret_id str: The name of the regional secret.
project str: The ID of the project in which the resource belongs.

location String: The location of the regional secret. eg us-central1
secretId String: The name of the regional secret.
project String: The ID of the project in which the resource belongs.

getRegionalSecret Result

The following output properties are available:

Annotations Dictionary<string, string>
CreateTime string
CustomerManagedEncryptions List<GetRegionalSecretCustomerManagedEncryption>
DeletionProtection bool
EffectiveAnnotations Dictionary<string, string>
EffectiveLabels Dictionary<string, string>
ExpireTime string
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
Location string
Name string
PulumiLabels Dictionary<string, string>
Rotations List<GetRegionalSecretRotation>
SecretId string
Tags Dictionary<string, string>
Topics List<GetRegionalSecretTopic>
Ttl string
VersionAliases Dictionary<string, string>
VersionDestroyTtl string
Project string

Annotations map[string]string
CreateTime string
CustomerManagedEncryptions []GetRegionalSecretCustomerManagedEncryption
DeletionProtection bool
EffectiveAnnotations map[string]string
EffectiveLabels map[string]string
ExpireTime string
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string
Location string
Name string
PulumiLabels map[string]string
Rotations []GetRegionalSecretRotation
SecretId string
Tags map[string]string
Topics []GetRegionalSecretTopic
Ttl string
VersionAliases map[string]string
VersionDestroyTtl string
Project string

annotations Map<String,String>
createTime String
customerManagedEncryptions List<GetRegionalSecretCustomerManagedEncryption>
deletionProtection Boolean
effectiveAnnotations Map<String,String>
effectiveLabels Map<String,String>
expireTime String
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>
location String
name String
pulumiLabels Map<String,String>
rotations List<GetRegionalSecretRotation>
secretId String
tags Map<String,String>
topics List<GetRegionalSecretTopic>
ttl String
versionAliases Map<String,String>
versionDestroyTtl String
project String

annotations {[key: string]: string}
createTime string
customerManagedEncryptions GetRegionalSecretCustomerManagedEncryption[]
deletionProtection boolean
effectiveAnnotations {[key: string]: string}
effectiveLabels {[key: string]: string}
expireTime string
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
location string
name string
pulumiLabels {[key: string]: string}
rotations GetRegionalSecretRotation[]
secretId string
tags {[key: string]: string}
topics GetRegionalSecretTopic[]
ttl string
versionAliases {[key: string]: string}
versionDestroyTtl string
project string

annotations Mapping[str, str]
create_time str
customer_managed_encryptions Sequence[GetRegionalSecretCustomerManagedEncryption]
deletion_protection bool
effective_annotations Mapping[str, str]
effective_labels Mapping[str, str]
expire_time str
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
location str
name str
pulumi_labels Mapping[str, str]
rotations Sequence[GetRegionalSecretRotation]
secret_id str
tags Mapping[str, str]
topics Sequence[GetRegionalSecretTopic]
ttl str
version_aliases Mapping[str, str]
version_destroy_ttl str
project str

annotations Map<String>
createTime String
customerManagedEncryptions List<Property Map>
deletionProtection Boolean
effectiveAnnotations Map<String>
effectiveLabels Map<String>
expireTime String
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>
location String
name String
pulumiLabels Map<String>
rotations List<Property Map>
secretId String
tags Map<String>
topics List<Property Map>
ttl String
versionAliases Map<String>
versionDestroyTtl String
project String

Supporting Types

GetRegionalSecretCustomerManagedEncryption

KmsKeyName string: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

KmsKeyName string: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

kmsKeyName String: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

kmsKeyName string: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

kms_key_name str: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

kmsKeyName String: The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

GetRegionalSecretRotation

NextRotationTime string: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
RotationPeriod string: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

NextRotationTime string: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
RotationPeriod string: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

nextRotationTime String: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
rotationPeriod String: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

nextRotationTime string: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
rotationPeriod string: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

next_rotation_time str: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
rotation_period str: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

nextRotationTime String: Timestamp in UTC at which the Secret is scheduled to rotate. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
rotationPeriod String: The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotationPeriod is set, 'next_rotation_time' must be set. 'next_rotation_time' will be advanced by this period when the service automatically sends rotation notifications.

GetRegionalSecretTopic

Name string: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.

Name string: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.

name String: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.

name string: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.

name str: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.

name String: The resource name of the Pub/Sub topic that will be published to, in the following format: projects//topics/. For publication to succeed, the Secret Manager Service Agent service account must have pubsub.publisher permissions on the topic.