1. Packages
  2. Volcengine
  3. API Docs
  4. kms
  5. getKeyrings
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.kms.getKeyrings

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of kms keyrings

    Example Usage

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

const default = volcengine.kms.getKeyrings({
    descriptions: [
        "tf-1",
        "tf-2",
    ],
    keyringNames: [
        "tf-test-1",
        "tf-test-2",
        "tf-test-3",
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.kms.get_keyrings(descriptions=[
        "tf-1",
        "tf-2",
    ],
    keyring_names=[
        "tf-test-1",
        "tf-test-2",
        "tf-test-3",
    ])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/kms"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.GetKeyrings(ctx, &kms.GetKeyringsArgs{
			Descriptions: []string{
				"tf-1",
				"tf-2",
			},
			KeyringNames: []string{
				"tf-test-1",
				"tf-test-2",
				"tf-test-3",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Kms.GetKeyrings.Invoke(new()
    {
        Descriptions = new[]
        {
            "tf-1",
            "tf-2",
        },
        KeyringNames = new[]
        {
            "tf-test-1",
            "tf-test-2",
            "tf-test-3",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.kms.KmsFunctions;
import com.pulumi.volcengine.kms.inputs.GetKeyringsArgs;
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 default = KmsFunctions.getKeyrings(GetKeyringsArgs.builder()
            .descriptions(            
                "tf-1",
                "tf-2")
            .keyringNames(            
                "tf-test-1",
                "tf-test-2",
                "tf-test-3")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:kms:getKeyrings
      Arguments:
        descriptions:
          - tf-1
          - tf-2
        keyringNames:
          - tf-test-1
          - tf-test-2
          - tf-test-3

    Using getKeyrings

    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 getKeyrings(args: GetKeyringsArgs, opts?: InvokeOptions): Promise<GetKeyringsResult>
function getKeyringsOutput(args: GetKeyringsOutputArgs, opts?: InvokeOptions): Output<GetKeyringsResult>
    def get_keyrings(creation_date_ranges: Optional[Sequence[str]] = None,
                 descriptions: Optional[Sequence[str]] = None,
                 keyring_names: Optional[Sequence[str]] = None,
                 keyring_types: Optional[Sequence[str]] = None,
                 name_regex: Optional[str] = None,
                 output_file: Optional[str] = None,
                 project_name: Optional[str] = None,
                 update_date_ranges: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetKeyringsResult
def get_keyrings_output(creation_date_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 descriptions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 keyring_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 keyring_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 project_name: Optional[pulumi.Input[str]] = None,
                 update_date_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetKeyringsResult]
    func GetKeyrings(ctx *Context, args *GetKeyringsArgs, opts ...InvokeOption) (*GetKeyringsResult, error)
func GetKeyringsOutput(ctx *Context, args *GetKeyringsOutputArgs, opts ...InvokeOption) GetKeyringsResultOutput

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

    public static class GetKeyrings 
{
    public static Task<GetKeyringsResult> InvokeAsync(GetKeyringsArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyringsResult> Invoke(GetKeyringsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyringsResult> getKeyrings(GetKeyringsArgs args, InvokeOptions options)
public static Output<GetKeyringsResult> getKeyrings(GetKeyringsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:kms/getKeyrings:getKeyrings
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CreationDateRanges List<string>
    The creation date of the keyring.
    Descriptions List<string>
    The description of the keyring.
    KeyringNames List<string>
    The name of the keyring.
    KeyringTypes List<string>
    The type of the keyring.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The name of the project.
    UpdateDateRanges List<string>
    The update date of the keyring.
    CreationDateRanges []string
    The creation date of the keyring.
    Descriptions []string
    The description of the keyring.
    KeyringNames []string
    The name of the keyring.
    KeyringTypes []string
    The type of the keyring.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The name of the project.
    UpdateDateRanges []string
    The update date of the keyring.
    creationDateRanges List<String>
    The creation date of the keyring.
    descriptions List<String>
    The description of the keyring.
    keyringNames List<String>
    The name of the keyring.
    keyringTypes List<String>
    The type of the keyring.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The name of the project.
    updateDateRanges List<String>
    The update date of the keyring.
    creationDateRanges string[]
    The creation date of the keyring.
    descriptions string[]
    The description of the keyring.
    keyringNames string[]
    The name of the keyring.
    keyringTypes string[]
    The type of the keyring.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    projectName string
    The name of the project.
    updateDateRanges string[]
    The update date of the keyring.
    creation_date_ranges Sequence[str]
    The creation date of the keyring.
    descriptions Sequence[str]
    The description of the keyring.
    keyring_names Sequence[str]
    The name of the keyring.
    keyring_types Sequence[str]
    The type of the keyring.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    project_name str
    The name of the project.
    update_date_ranges Sequence[str]
    The update date of the keyring.
    creationDateRanges List<String>
    The creation date of the keyring.
    descriptions List<String>
    The description of the keyring.
    keyringNames List<String>
    The name of the keyring.
    keyringTypes List<String>
    The type of the keyring.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The name of the project.
    updateDateRanges List<String>
    The update date of the keyring.

    getKeyrings Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Keyrings List<GetKeyringsKeyring>
    The information about the keyring.
    TotalCount int
    The total count of query.
    CreationDateRanges List<string>
    Descriptions List<string>
    The description of the keyring.
    KeyringNames List<string>
    The name of the keyring.
    KeyringTypes List<string>
    The type of the keyring.
    NameRegex string
    OutputFile string
    ProjectName string
    UpdateDateRanges List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Keyrings []GetKeyringsKeyring
    The information about the keyring.
    TotalCount int
    The total count of query.
    CreationDateRanges []string
    Descriptions []string
    The description of the keyring.
    KeyringNames []string
    The name of the keyring.
    KeyringTypes []string
    The type of the keyring.
    NameRegex string
    OutputFile string
    ProjectName string
    UpdateDateRanges []string
    id String
    The provider-assigned unique ID for this managed resource.
    keyrings List<GetKeyringsKeyring>
    The information about the keyring.
    totalCount Integer
    The total count of query.
    creationDateRanges List<String>
    descriptions List<String>
    The description of the keyring.
    keyringNames List<String>
    The name of the keyring.
    keyringTypes List<String>
    The type of the keyring.
    nameRegex String
    outputFile String
    projectName String
    updateDateRanges List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    keyrings GetKeyringsKeyring[]
    The information about the keyring.
    totalCount number
    The total count of query.
    creationDateRanges string[]
    descriptions string[]
    The description of the keyring.
    keyringNames string[]
    The name of the keyring.
    keyringTypes string[]
    The type of the keyring.
    nameRegex string
    outputFile string
    projectName string
    updateDateRanges string[]
    id str
    The provider-assigned unique ID for this managed resource.
    keyrings Sequence[GetKeyringsKeyring]
    The information about the keyring.
    total_count int
    The total count of query.
    creation_date_ranges Sequence[str]
    descriptions Sequence[str]
    The description of the keyring.
    keyring_names Sequence[str]
    The name of the keyring.
    keyring_types Sequence[str]
    The type of the keyring.
    name_regex str
    output_file str
    project_name str
    update_date_ranges Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    keyrings List<Property Map>
    The information about the keyring.
    totalCount Number
    The total count of query.
    creationDateRanges List<String>
    descriptions List<String>
    The description of the keyring.
    keyringNames List<String>
    The name of the keyring.
    keyringTypes List<String>
    The type of the keyring.
    nameRegex String
    outputFile String
    projectName String
    updateDateRanges List<String>

    Supporting Types

    GetKeyringsKeyring

    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the keyring.
    Id string
    The unique ID of the keyring. The value is in the UUID format.
    KeyCount int
    Key ring key count.
    KeyringName string
    The name of the keyring.
    KeyringType string
    The type of the keyring.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the keyring.
    Id string
    The unique ID of the keyring. The value is in the UUID format.
    KeyCount int
    Key ring key count.
    KeyringName string
    The name of the keyring.
    KeyringType string
    The type of the keyring.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    creationDate Integer
    The date when the keyring was created.
    description String
    The description of the keyring.
    id String
    The unique ID of the keyring. The value is in the UUID format.
    keyCount Integer
    Key ring key count.
    keyringName String
    The name of the keyring.
    keyringType String
    The type of the keyring.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Integer
    The date when the keyring was updated.
    creationDate number
    The date when the keyring was created.
    description string
    The description of the keyring.
    id string
    The unique ID of the keyring. The value is in the UUID format.
    keyCount number
    Key ring key count.
    keyringName string
    The name of the keyring.
    keyringType string
    The type of the keyring.
    trn string
    The information about the tenant resource name (TRN).
    uid string
    The tenant ID of the keyring.
    updateDate number
    The date when the keyring was updated.
    creation_date int
    The date when the keyring was created.
    description str
    The description of the keyring.
    id str
    The unique ID of the keyring. The value is in the UUID format.
    key_count int
    Key ring key count.
    keyring_name str
    The name of the keyring.
    keyring_type str
    The type of the keyring.
    trn str
    The information about the tenant resource name (TRN).
    uid str
    The tenant ID of the keyring.
    update_date int
    The date when the keyring was updated.
    creationDate Number
    The date when the keyring was created.
    description String
    The description of the keyring.
    id String
    The unique ID of the keyring. The value is in the UUID format.
    keyCount Number
    Key ring key count.
    keyringName String
    The name of the keyring.
    keyringType String
    The type of the keyring.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Number
    The date when the keyring was updated.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate