Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. secretmanager
  5. getRegionalSecrets
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.secretmanager.getRegionalSecrets

Explore with Pulumi AI

gcp logo
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

    Use this data source to list the Secret Manager Regional Secrets.

    Example Usage

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

const secrets = gcp.secretmanager.getRegionalSecrets({
    location: "us-central1",
});

    import pulumi
import pulumi_gcp as gcp

secrets = gcp.secretmanager.get_regional_secrets(location="us-central1")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secretmanager.GetRegionalSecrets(ctx, &secretmanager.GetRegionalSecretsArgs{
			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 secrets = Gcp.SecretManager.GetRegionalSecrets.Invoke(new()
    {
        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.GetRegionalSecretsArgs;
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 secrets = SecretmanagerFunctions.getRegionalSecrets(GetRegionalSecretsArgs.builder()
            .location("us-central1")
            .build());

    }
}

    variables:
  secrets:
    fn::invoke:
      function: gcp:secretmanager:getRegionalSecrets
      arguments:
        location: us-central1

    Using getRegionalSecrets

    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 getRegionalSecrets(args: GetRegionalSecretsArgs, opts?: InvokeOptions): Promise<GetRegionalSecretsResult>
function getRegionalSecretsOutput(args: GetRegionalSecretsOutputArgs, opts?: InvokeOptions): Output<GetRegionalSecretsResult>
    def get_regional_secrets(filter: Optional[str] = None,
                         location: Optional[str] = None,
                         project: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRegionalSecretsResult
def get_regional_secrets_output(filter: Optional[pulumi.Input[str]] = None,
                         location: Optional[pulumi.Input[str]] = None,
                         project: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRegionalSecretsResult]
    func GetRegionalSecrets(ctx *Context, args *GetRegionalSecretsArgs, opts ...InvokeOption) (*GetRegionalSecretsResult, error)
func GetRegionalSecretsOutput(ctx *Context, args *GetRegionalSecretsOutputArgs, opts ...InvokeOption) GetRegionalSecretsResultOutput

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

    public static class GetRegionalSecrets 
{
    public static Task<GetRegionalSecretsResult> InvokeAsync(GetRegionalSecretsArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionalSecretsResult> Invoke(GetRegionalSecretsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRegionalSecretsResult> getRegionalSecrets(GetRegionalSecretsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Location string
    The location of the regional secret.
    Filter string
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    Project string
    The ID of the project.
    Location string
    The location of the regional secret.
    Filter string
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    Project string
    The ID of the project.
    location String
    The location of the regional secret.
    filter String
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    project String
    The ID of the project.
    location string
    The location of the regional secret.
    filter string
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    project string
    The ID of the project.
    location str
    The location of the regional secret.
    filter str
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    project str
    The ID of the project.
    location String
    The location of the regional secret.
    filter String
    Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all regional secrets are listed from the specified location.
    project String
    The ID of the project.

    getRegionalSecrets Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The location in which the resource belongs.
    Project string
    The ID of the project in which the resource belongs.
    Secrets List<GetRegionalSecretsSecret>
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    Filter string
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The location in which the resource belongs.
    Project string
    The ID of the project in which the resource belongs.
    Secrets []GetRegionalSecretsSecret
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    Filter string
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The location in which the resource belongs.
    project String
    The ID of the project in which the resource belongs.
    secrets List<GetRegionalSecretsSecret>
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    filter String
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The location in which the resource belongs.
    project string
    The ID of the project in which the resource belongs.
    secrets GetRegionalSecretsSecret[]
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    filter string
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The location in which the resource belongs.
    project str
    The ID of the project in which the resource belongs.
    secrets Sequence[GetRegionalSecretsSecret]
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    filter str
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The location in which the resource belongs.
    project String
    The ID of the project in which the resource belongs.
    secrets List<Property Map>
    A list of regional secrets present in the specified location and matching the filter. Structure is defined below.
    filter String

    Supporting Types

    GetRegionalSecretsSecret

    Annotations Dictionary<string, string>
    Custom metadata about the regional secret.
    CreateTime string
    The time at which the regional secret was created.
    CustomerManagedEncryptions List<GetRegionalSecretsSecretCustomerManagedEncryption>
    Customer Managed Encryption for the regional secret. Structure is documented below.
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    ExpireTime string
    Timestamp in UTC when the regional secret is scheduled to expire.
    Labels Dictionary<string, string>
    The labels assigned to this regional secret.
    Location string
    The location of the regional secret.
    Name string
    The resource name of the Pub/Sub topic that will be published to.
    Project string
    The ID of the project.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Rotations List<GetRegionalSecretsSecretRotation>
    The rotation time and period for a regional secret. Structure is documented below.
    SecretId string
    The unique name of the resource.
    Topics List<GetRegionalSecretsSecretTopic>
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    Ttl string
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    VersionAliases Dictionary<string, string>
    Mapping from version alias to version name.
    VersionDestroyTtl string
    The version destroy ttl for the regional secret version.
    Annotations map[string]string
    Custom metadata about the regional secret.
    CreateTime string
    The time at which the regional secret was created.
    CustomerManagedEncryptions []GetRegionalSecretsSecretCustomerManagedEncryption
    Customer Managed Encryption for the regional secret. Structure is documented below.
    EffectiveAnnotations map[string]string
    EffectiveLabels map[string]string
    ExpireTime string
    Timestamp in UTC when the regional secret is scheduled to expire.
    Labels map[string]string
    The labels assigned to this regional secret.
    Location string
    The location of the regional secret.
    Name string
    The resource name of the Pub/Sub topic that will be published to.
    Project string
    The ID of the project.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Rotations []GetRegionalSecretsSecretRotation
    The rotation time and period for a regional secret. Structure is documented below.
    SecretId string
    The unique name of the resource.
    Topics []GetRegionalSecretsSecretTopic
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    Ttl string
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    VersionAliases map[string]string
    Mapping from version alias to version name.
    VersionDestroyTtl string
    The version destroy ttl for the regional secret version.
    annotations Map<String,String>
    Custom metadata about the regional secret.
    createTime String
    The time at which the regional secret was created.
    customerManagedEncryptions List<GetRegionalSecretsSecretCustomerManagedEncryption>
    Customer Managed Encryption for the regional secret. Structure is documented below.
    effectiveAnnotations Map<String,String>
    effectiveLabels Map<String,String>
    expireTime String
    Timestamp in UTC when the regional secret is scheduled to expire.
    labels Map<String,String>
    The labels assigned to this regional secret.
    location String
    The location of the regional secret.
    name String
    The resource name of the Pub/Sub topic that will be published to.
    project String
    The ID of the project.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    rotations List<GetRegionalSecretsSecretRotation>
    The rotation time and period for a regional secret. Structure is documented below.
    secretId String
    The unique name of the resource.
    topics List<GetRegionalSecretsSecretTopic>
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    ttl String
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    versionAliases Map<String,String>
    Mapping from version alias to version name.
    versionDestroyTtl String
    The version destroy ttl for the regional secret version.
    annotations {[key: string]: string}
    Custom metadata about the regional secret.
    createTime string
    The time at which the regional secret was created.
    customerManagedEncryptions GetRegionalSecretsSecretCustomerManagedEncryption[]
    Customer Managed Encryption for the regional secret. Structure is documented below.
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[key: string]: string}
    expireTime string
    Timestamp in UTC when the regional secret is scheduled to expire.
    labels {[key: string]: string}
    The labels assigned to this regional secret.
    location string
    The location of the regional secret.
    name string
    The resource name of the Pub/Sub topic that will be published to.
    project string
    The ID of the project.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    rotations GetRegionalSecretsSecretRotation[]
    The rotation time and period for a regional secret. Structure is documented below.
    secretId string
    The unique name of the resource.
    topics GetRegionalSecretsSecretTopic[]
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    ttl string
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    versionAliases {[key: string]: string}
    Mapping from version alias to version name.
    versionDestroyTtl string
    The version destroy ttl for the regional secret version.
    annotations Mapping[str, str]
    Custom metadata about the regional secret.
    create_time str
    The time at which the regional secret was created.
    customer_managed_encryptions Sequence[GetRegionalSecretsSecretCustomerManagedEncryption]
    Customer Managed Encryption for the regional secret. Structure is documented below.
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    expire_time str
    Timestamp in UTC when the regional secret is scheduled to expire.
    labels Mapping[str, str]
    The labels assigned to this regional secret.
    location str
    The location of the regional secret.
    name str
    The resource name of the Pub/Sub topic that will be published to.
    project str
    The ID of the project.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    rotations Sequence[GetRegionalSecretsSecretRotation]
    The rotation time and period for a regional secret. Structure is documented below.
    secret_id str
    The unique name of the resource.
    topics Sequence[GetRegionalSecretsSecretTopic]
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    ttl str
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    version_aliases Mapping[str, str]
    Mapping from version alias to version name.
    version_destroy_ttl str
    The version destroy ttl for the regional secret version.
    annotations Map<String>
    Custom metadata about the regional secret.
    createTime String
    The time at which the regional secret was created.
    customerManagedEncryptions List<Property Map>
    Customer Managed Encryption for the regional secret. Structure is documented below.
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    expireTime String
    Timestamp in UTC when the regional secret is scheduled to expire.
    labels Map<String>
    The labels assigned to this regional secret.
    location String
    The location of the regional secret.
    name String
    The resource name of the Pub/Sub topic that will be published to.
    project String
    The ID of the project.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    rotations List<Property Map>
    The rotation time and period for a regional secret. Structure is documented below.
    secretId String
    The unique name of the resource.
    topics List<Property Map>
    A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the regional secret or its versions. Structure is documented below.
    ttl String
    The TTL for the regional secret. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Only one of 'ttl' or 'expire_time' can be provided.
    versionAliases Map<String>
    Mapping from version alias to version name.
    versionDestroyTtl String
    The version destroy ttl for the regional secret version.

    GetRegionalSecretsSecretCustomerManagedEncryption

    KmsKeyName string
    Describes the Cloud KMS encryption key that will be used to protect destination secret.
    KmsKeyName string
    Describes the Cloud KMS encryption key that will be used to protect destination secret.
    kmsKeyName String
    Describes the Cloud KMS encryption key that will be used to protect destination secret.
    kmsKeyName string
    Describes the Cloud KMS encryption key that will be used to protect destination secret.
    kms_key_name str
    Describes the Cloud KMS encryption key that will be used to protect destination secret.
    kmsKeyName String
    Describes the Cloud KMS encryption key that will be used to protect destination secret.

    GetRegionalSecretsSecretRotation

    NextRotationTime string
    Timestamp in UTC at which the secret is scheduled to rotate.
    RotationPeriod string
    The Duration between rotation notifications.
    NextRotationTime string
    Timestamp in UTC at which the secret is scheduled to rotate.
    RotationPeriod string
    The Duration between rotation notifications.
    nextRotationTime String
    Timestamp in UTC at which the secret is scheduled to rotate.
    rotationPeriod String
    The Duration between rotation notifications.
    nextRotationTime string
    Timestamp in UTC at which the secret is scheduled to rotate.
    rotationPeriod string
    The Duration between rotation notifications.
    next_rotation_time str
    Timestamp in UTC at which the secret is scheduled to rotate.
    rotation_period str
    The Duration between rotation notifications.
    nextRotationTime String
    Timestamp in UTC at which the secret is scheduled to rotate.
    rotationPeriod String
    The Duration between rotation notifications.

    GetRegionalSecretsSecretTopic

    Name string
    The resource name of the Pub/Sub topic that will be published to.
    Name string
    The resource name of the Pub/Sub topic that will be published to.
    name String
    The resource name of the Pub/Sub topic that will be published to.
    name string
    The resource name of the Pub/Sub topic that will be published to.
    name str
    The resource name of the Pub/Sub topic that will be published to.
    name String
    The resource name of the Pub/Sub topic that will be published to.

    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 v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
    pulumi/pulumi-gcp