Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. kms
  6. getCustomKeyStore
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.kms.getCustomKeyStore

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Use this data source to get the metadata KMS custom key store. By using this data source, you can reference KMS custom key store without having to hard code the ID as input.

    Example Usage

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

const keystore = aws.kms.getCustomKeyStore({
    customKeyStoreName: "my_cloudhsm",
});

    import pulumi
import pulumi_aws as aws

keystore = aws.kms.get_custom_key_store(custom_key_store_name="my_cloudhsm")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.LookupCustomKeyStore(ctx, &kms.LookupCustomKeyStoreArgs{
			CustomKeyStoreName: pulumi.StringRef("my_cloudhsm"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var keystore = Aws.Kms.GetCustomKeyStore.Invoke(new()
    {
        CustomKeyStoreName = "my_cloudhsm",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.KmsFunctions;
import com.pulumi.aws.kms.inputs.GetCustomKeyStoreArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 keystore = KmsFunctions.getCustomKeyStore(GetCustomKeyStoreArgs.builder()
            .customKeyStoreName("my_cloudhsm")
            .build());

    }
}

    variables:
  keystore:
    fn::invoke:
      function: aws:kms:getCustomKeyStore
      arguments:
        customKeyStoreName: my_cloudhsm

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_kms_custom_key_store" "keystore" {
  custom_key_store_name = "my_cloudhsm"
}

    Using getCustomKeyStore

    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 getCustomKeyStore(args: GetCustomKeyStoreArgs, opts?: InvokeOptions): Promise<GetCustomKeyStoreResult>
function getCustomKeyStoreOutput(args: GetCustomKeyStoreOutputArgs, opts?: InvokeOutputOptions): Output<GetCustomKeyStoreResult>
    def get_custom_key_store(custom_key_store_id: Optional[str] = None,
                         custom_key_store_name: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomKeyStoreResult
def get_custom_key_store_output(custom_key_store_id: pulumi.Input[Optional[str]] = None,
                         custom_key_store_name: pulumi.Input[Optional[str]] = None,
                         region: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetCustomKeyStoreResult]
    func LookupCustomKeyStore(ctx *Context, args *LookupCustomKeyStoreArgs, opts ...InvokeOption) (*LookupCustomKeyStoreResult, error)
func LookupCustomKeyStoreOutput(ctx *Context, args *LookupCustomKeyStoreOutputArgs, opts ...InvokeOption) LookupCustomKeyStoreResultOutput

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

    public static class GetCustomKeyStore 
{
    public static Task<GetCustomKeyStoreResult> InvokeAsync(GetCustomKeyStoreArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomKeyStoreResult> Invoke(GetCustomKeyStoreInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomKeyStoreResult> Invoke(GetCustomKeyStoreInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCustomKeyStoreResult> getCustomKeyStore(GetCustomKeyStoreArgs args, InvokeOptions options)
public static Output<GetCustomKeyStoreResult> getCustomKeyStore(GetCustomKeyStoreArgs args, InvokeOptions options)
public static Output<GetCustomKeyStoreResult> getCustomKeyStore(GetCustomKeyStoreArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:kms/getCustomKeyStore:getCustomKeyStore
  arguments:
    # arguments dictionary
    data "aws_kms_get_custom_key_store" "name" {
    # arguments
}

    The following arguments are supported:

    CustomKeyStoreId string
    ID for the custom key store.
    CustomKeyStoreName string
    User-specified friendly name for the custom key store.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    CustomKeyStoreId string
    ID for the custom key store.
    CustomKeyStoreName string
    User-specified friendly name for the custom key store.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    custom_key_store_id string
    ID for the custom key store.
    custom_key_store_name string
    User-specified friendly name for the custom key store.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customKeyStoreId String
    ID for the custom key store.
    customKeyStoreName String
    User-specified friendly name for the custom key store.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customKeyStoreId string
    ID for the custom key store.
    customKeyStoreName string
    User-specified friendly name for the custom key store.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    custom_key_store_id str
    ID for the custom key store.
    custom_key_store_name str
    User-specified friendly name for the custom key store.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customKeyStoreId String
    ID for the custom key store.
    customKeyStoreName String
    User-specified friendly name for the custom key store.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getCustomKeyStore Result

    The following output properties are available:

    CloudHsmClusterId string
    ID for the CloudHSM cluster that is associated with the custom key store.
    ConnectionState string
    Whether the custom key store is connected to its CloudHSM cluster.
    CreationDate string
    Date and time when the custom key store was created.
    CustomKeyStoreId string
    CustomKeyStoreName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    TrustAnchorCertificate string
    Trust anchor certificate of the associated CloudHSM cluster.
    CloudHsmClusterId string
    ID for the CloudHSM cluster that is associated with the custom key store.
    ConnectionState string
    Whether the custom key store is connected to its CloudHSM cluster.
    CreationDate string
    Date and time when the custom key store was created.
    CustomKeyStoreId string
    CustomKeyStoreName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    TrustAnchorCertificate string
    Trust anchor certificate of the associated CloudHSM cluster.
    cloud_hsm_cluster_id string
    ID for the CloudHSM cluster that is associated with the custom key store.
    connection_state string
    Whether the custom key store is connected to its CloudHSM cluster.
    creation_date string
    Date and time when the custom key store was created.
    custom_key_store_id string
    custom_key_store_name string
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    trust_anchor_certificate string
    Trust anchor certificate of the associated CloudHSM cluster.
    cloudHsmClusterId String
    ID for the CloudHSM cluster that is associated with the custom key store.
    connectionState String
    Whether the custom key store is connected to its CloudHSM cluster.
    creationDate String
    Date and time when the custom key store was created.
    customKeyStoreId String
    customKeyStoreName String
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    trustAnchorCertificate String
    Trust anchor certificate of the associated CloudHSM cluster.
    cloudHsmClusterId string
    ID for the CloudHSM cluster that is associated with the custom key store.
    connectionState string
    Whether the custom key store is connected to its CloudHSM cluster.
    creationDate string
    Date and time when the custom key store was created.
    customKeyStoreId string
    customKeyStoreName string
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    trustAnchorCertificate string
    Trust anchor certificate of the associated CloudHSM cluster.
    cloud_hsm_cluster_id str
    ID for the CloudHSM cluster that is associated with the custom key store.
    connection_state str
    Whether the custom key store is connected to its CloudHSM cluster.
    creation_date str
    Date and time when the custom key store was created.
    custom_key_store_id str
    custom_key_store_name str
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    trust_anchor_certificate str
    Trust anchor certificate of the associated CloudHSM cluster.
    cloudHsmClusterId String
    ID for the CloudHSM cluster that is associated with the custom key store.
    connectionState String
    Whether the custom key store is connected to its CloudHSM cluster.
    creationDate String
    Date and time when the custom key store was created.
    customKeyStoreId String
    customKeyStoreName String
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    trustAnchorCertificate String
    Trust anchor certificate of the associated CloudHSM cluster.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial