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

aws.kms.CustomKeyStore

aws logo aws logo
Viewing docs for AWS v7.53.0
published on Monday, Nov 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an AWS KMS (Key Management) Custom Key Store.

    Example Usage

    CloudHSM

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

const test = new aws.kms.CustomKeyStore("test", {
    cloudHsmClusterId: cloudHsmClusterId,
    customKeyStoreName: "kms-custom-key-store-test",
    keyStorePassword: "noplaintextpasswords1",
    trustAnchorCertificate: std.file({
        input: "anchor-certificate.crt",
    }).then(invoke => invoke.result),
});

    import pulumi
import pulumi_aws as aws
import pulumi_std as std

test = aws.kms.CustomKeyStore("test",
    cloud_hsm_cluster_id=cloud_hsm_cluster_id,
    custom_key_store_name="kms-custom-key-store-test",
    key_store_password="noplaintextpasswords1",
    trust_anchor_certificate=std.file(input="anchor-certificate.crt").result)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "anchor-certificate.crt",
		}, nil)
		if err != nil {
			return err
		}
		_, err = kms.NewCustomKeyStore(ctx, "test", &kms.CustomKeyStoreArgs{
			CloudHsmClusterId:      pulumi.Any(cloudHsmClusterId),
			CustomKeyStoreName:     pulumi.String("kms-custom-key-store-test"),
			KeyStorePassword:       pulumi.String("noplaintextpasswords1"),
			TrustAnchorCertificate: pulumi.String(invokeFile.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Kms.CustomKeyStore("test", new()
    {
        CloudHsmClusterId = cloudHsmClusterId,
        CustomKeyStoreName = "kms-custom-key-store-test",
        KeyStorePassword = "noplaintextpasswords1",
        TrustAnchorCertificate = Std.File.Invoke(new()
        {
            Input = "anchor-certificate.crt",
        }).Apply(invoke => invoke.Result),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.CustomKeyStore;
import com.pulumi.aws.kms.CustomKeyStoreArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
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) {
        var test = new CustomKeyStore("test", CustomKeyStoreArgs.builder()
            .cloudHsmClusterId(cloudHsmClusterId)
            .customKeyStoreName("kms-custom-key-store-test")
            .keyStorePassword("noplaintextpasswords1")
            .trustAnchorCertificate(StdFunctions.file(FileArgs.builder()
                .input("anchor-certificate.crt")
                .build()).result())
            .build());

    }
}

    resources:
  test:
    type: aws:kms:CustomKeyStore
    properties:
      cloudHsmClusterId: ${cloudHsmClusterId}
      customKeyStoreName: kms-custom-key-store-test
      keyStorePassword: noplaintextpasswords1
      trustAnchorCertificate:
        fn::invoke:
          function: std:file
          arguments:
            input: anchor-certificate.crt
          return: result

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

resource "aws_kms_custom_key_store" "test" {
  lifecycle {
    create_before_destroy = true
  }
  cloud_hsm_cluster_id     = cloudHsmClusterId
  custom_key_store_name    = "kms-custom-key-store-test"
  key_store_password       = "noplaintextpasswords1"
  trust_anchor_certificate = file("anchor-certificate.crt")
}

    External Key Store (VPC)

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

const example = new aws.kms.CustomKeyStore("example", {
    xksProxyAuthenticationCredential: {
        accessKeyId: ephemeralAccessKeyId,
        rawSecretAccessKey: ephemeralSecretAccessKey,
    },
    customKeyStoreName: "example-vpc-xks",
    customKeyStoreType: "EXTERNAL_KEY_STORE",
    xksProxyConnectivity: "VPC_ENDPOINT_SERVICE",
    xksProxyUriEndpoint: "https://myproxy-private.xks.example.com",
    xksProxyUriPath: "/kms/xks/v1",
    xksProxyVpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example",
});

    import pulumi
import pulumi_aws as aws

example = aws.kms.CustomKeyStore("example",
    xks_proxy_authentication_credential={
        "access_key_id": ephemeral_access_key_id,
        "raw_secret_access_key": ephemeral_secret_access_key,
    },
    custom_key_store_name="example-vpc-xks",
    custom_key_store_type="EXTERNAL_KEY_STORE",
    xks_proxy_connectivity="VPC_ENDPOINT_SERVICE",
    xks_proxy_uri_endpoint="https://myproxy-private.xks.example.com",
    xks_proxy_uri_path="/kms/xks/v1",
    xks_proxy_vpc_endpoint_service_name="com.amazonaws.vpce.us-east-1.vpce-svc-example")

    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.NewCustomKeyStore(ctx, "example", &kms.CustomKeyStoreArgs{
			XksProxyAuthenticationCredential: &kms.CustomKeyStoreXksProxyAuthenticationCredentialArgs{
				AccessKeyId:        pulumi.Any(ephemeralAccessKeyId),
				RawSecretAccessKey: pulumi.Any(ephemeralSecretAccessKey),
			},
			CustomKeyStoreName:             pulumi.String("example-vpc-xks"),
			CustomKeyStoreType:             pulumi.String("EXTERNAL_KEY_STORE"),
			XksProxyConnectivity:           pulumi.String("VPC_ENDPOINT_SERVICE"),
			XksProxyUriEndpoint:            pulumi.String("https://myproxy-private.xks.example.com"),
			XksProxyUriPath:                pulumi.String("/kms/xks/v1"),
			XksProxyVpcEndpointServiceName: pulumi.String("com.amazonaws.vpce.us-east-1.vpce-svc-example"),
		})
		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 example = new Aws.Kms.CustomKeyStore("example", new()
    {
        XksProxyAuthenticationCredential = new Aws.Kms.Inputs.CustomKeyStoreXksProxyAuthenticationCredentialArgs
        {
            AccessKeyId = ephemeralAccessKeyId,
            RawSecretAccessKey = ephemeralSecretAccessKey,
        },
        CustomKeyStoreName = "example-vpc-xks",
        CustomKeyStoreType = "EXTERNAL_KEY_STORE",
        XksProxyConnectivity = "VPC_ENDPOINT_SERVICE",
        XksProxyUriEndpoint = "https://myproxy-private.xks.example.com",
        XksProxyUriPath = "/kms/xks/v1",
        XksProxyVpcEndpointServiceName = "com.amazonaws.vpce.us-east-1.vpce-svc-example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.CustomKeyStore;
import com.pulumi.aws.kms.CustomKeyStoreArgs;
import com.pulumi.aws.kms.inputs.CustomKeyStoreXksProxyAuthenticationCredentialArgs;
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) {
        var example = new CustomKeyStore("example", CustomKeyStoreArgs.builder()
            .xksProxyAuthenticationCredential(CustomKeyStoreXksProxyAuthenticationCredentialArgs.builder()
                .accessKeyId(ephemeralAccessKeyId)
                .rawSecretAccessKey(ephemeralSecretAccessKey)
                .build())
            .customKeyStoreName("example-vpc-xks")
            .customKeyStoreType("EXTERNAL_KEY_STORE")
            .xksProxyConnectivity("VPC_ENDPOINT_SERVICE")
            .xksProxyUriEndpoint("https://myproxy-private.xks.example.com")
            .xksProxyUriPath("/kms/xks/v1")
            .xksProxyVpcEndpointServiceName("com.amazonaws.vpce.us-east-1.vpce-svc-example")
            .build());

    }
}

    resources:
  example:
    type: aws:kms:CustomKeyStore
    properties:
      xksProxyAuthenticationCredential:
        accessKeyId: ${ephemeralAccessKeyId}
        rawSecretAccessKey: ${ephemeralSecretAccessKey}
      customKeyStoreName: example-vpc-xks
      customKeyStoreType: EXTERNAL_KEY_STORE
      xksProxyConnectivity: VPC_ENDPOINT_SERVICE
      xksProxyUriEndpoint: https://myproxy-private.xks.example.com
      xksProxyUriPath: /kms/xks/v1
      xksProxyVpcEndpointServiceName: com.amazonaws.vpce.us-east-1.vpce-svc-example

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

resource "aws_kms_custom_key_store" "example" {
  lifecycle {
    create_before_destroy = true
  }
  xks_proxy_authentication_credential {
    access_key_id         = ephemeralAccessKeyId
    raw_secret_access_key = ephemeralSecretAccessKey
  }
  custom_key_store_name               = "example-vpc-xks"
  custom_key_store_type               = "EXTERNAL_KEY_STORE"
  xks_proxy_connectivity              = "VPC_ENDPOINT_SERVICE"
  xks_proxy_uri_endpoint              = "https://myproxy-private.xks.example.com"
  xks_proxy_uri_path                  = "/kms/xks/v1"
  xks_proxy_vpc_endpoint_service_name = "com.amazonaws.vpce.us-east-1.vpce-svc-example"
}

    External Key Store (Public)

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

const example = new aws.kms.CustomKeyStore("example", {
    xksProxyAuthenticationCredential: {
        accessKeyId: ephemeralAccessKeyId,
        rawSecretAccessKey: ephemeralSecretAccessKey,
    },
    customKeyStoreName: "example-public-xks",
    customKeyStoreType: "EXTERNAL_KEY_STORE",
    xksProxyConnectivity: "PUBLIC_ENDPOINT",
    xksProxyUriEndpoint: "https://myproxy.xks.example.com",
    xksProxyUriPath: "/kms/xks/v1",
});

    import pulumi
import pulumi_aws as aws

example = aws.kms.CustomKeyStore("example",
    xks_proxy_authentication_credential={
        "access_key_id": ephemeral_access_key_id,
        "raw_secret_access_key": ephemeral_secret_access_key,
    },
    custom_key_store_name="example-public-xks",
    custom_key_store_type="EXTERNAL_KEY_STORE",
    xks_proxy_connectivity="PUBLIC_ENDPOINT",
    xks_proxy_uri_endpoint="https://myproxy.xks.example.com",
    xks_proxy_uri_path="/kms/xks/v1")

    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.NewCustomKeyStore(ctx, "example", &kms.CustomKeyStoreArgs{
			XksProxyAuthenticationCredential: &kms.CustomKeyStoreXksProxyAuthenticationCredentialArgs{
				AccessKeyId:        pulumi.Any(ephemeralAccessKeyId),
				RawSecretAccessKey: pulumi.Any(ephemeralSecretAccessKey),
			},
			CustomKeyStoreName:   pulumi.String("example-public-xks"),
			CustomKeyStoreType:   pulumi.String("EXTERNAL_KEY_STORE"),
			XksProxyConnectivity: pulumi.String("PUBLIC_ENDPOINT"),
			XksProxyUriEndpoint:  pulumi.String("https://myproxy.xks.example.com"),
			XksProxyUriPath:      pulumi.String("/kms/xks/v1"),
		})
		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 example = new Aws.Kms.CustomKeyStore("example", new()
    {
        XksProxyAuthenticationCredential = new Aws.Kms.Inputs.CustomKeyStoreXksProxyAuthenticationCredentialArgs
        {
            AccessKeyId = ephemeralAccessKeyId,
            RawSecretAccessKey = ephemeralSecretAccessKey,
        },
        CustomKeyStoreName = "example-public-xks",
        CustomKeyStoreType = "EXTERNAL_KEY_STORE",
        XksProxyConnectivity = "PUBLIC_ENDPOINT",
        XksProxyUriEndpoint = "https://myproxy.xks.example.com",
        XksProxyUriPath = "/kms/xks/v1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.CustomKeyStore;
import com.pulumi.aws.kms.CustomKeyStoreArgs;
import com.pulumi.aws.kms.inputs.CustomKeyStoreXksProxyAuthenticationCredentialArgs;
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) {
        var example = new CustomKeyStore("example", CustomKeyStoreArgs.builder()
            .xksProxyAuthenticationCredential(CustomKeyStoreXksProxyAuthenticationCredentialArgs.builder()
                .accessKeyId(ephemeralAccessKeyId)
                .rawSecretAccessKey(ephemeralSecretAccessKey)
                .build())
            .customKeyStoreName("example-public-xks")
            .customKeyStoreType("EXTERNAL_KEY_STORE")
            .xksProxyConnectivity("PUBLIC_ENDPOINT")
            .xksProxyUriEndpoint("https://myproxy.xks.example.com")
            .xksProxyUriPath("/kms/xks/v1")
            .build());

    }
}

    resources:
  example:
    type: aws:kms:CustomKeyStore
    properties:
      xksProxyAuthenticationCredential:
        accessKeyId: ${ephemeralAccessKeyId}
        rawSecretAccessKey: ${ephemeralSecretAccessKey}
      customKeyStoreName: example-public-xks
      customKeyStoreType: EXTERNAL_KEY_STORE
      xksProxyConnectivity: PUBLIC_ENDPOINT
      xksProxyUriEndpoint: https://myproxy.xks.example.com
      xksProxyUriPath: /kms/xks/v1

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

resource "aws_kms_custom_key_store" "example" {
  lifecycle {
    create_before_destroy = true
  }
  xks_proxy_authentication_credential {
    access_key_id         = ephemeralAccessKeyId
    raw_secret_access_key = ephemeralSecretAccessKey
  }
  custom_key_store_name  = "example-public-xks"
  custom_key_store_type  = "EXTERNAL_KEY_STORE"
  xks_proxy_connectivity = "PUBLIC_ENDPOINT"
  xks_proxy_uri_endpoint = "https://myproxy.xks.example.com"
  xks_proxy_uri_path     = "/kms/xks/v1"
}

    Create CustomKeyStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomKeyStore(name: string, args: CustomKeyStoreArgs, opts?: CustomResourceOptions);
    @overload
def CustomKeyStore(resource_name: str,
                   args: CustomKeyStoreArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CustomKeyStore(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   custom_key_store_name: Optional[str] = None,
                   cloud_hsm_cluster_id: Optional[str] = None,
                   custom_key_store_type: Optional[str] = None,
                   key_store_password: Optional[str] = None,
                   region: Optional[str] = None,
                   trust_anchor_certificate: Optional[str] = None,
                   xks_proxy_authentication_credential: Optional[CustomKeyStoreXksProxyAuthenticationCredentialArgs] = None,
                   xks_proxy_connectivity: Optional[str] = None,
                   xks_proxy_uri_endpoint: Optional[str] = None,
                   xks_proxy_uri_path: Optional[str] = None,
                   xks_proxy_vpc_endpoint_service_name: Optional[str] = None)
    func NewCustomKeyStore(ctx *Context, name string, args CustomKeyStoreArgs, opts ...ResourceOption) (*CustomKeyStore, error)
    public CustomKeyStore(string name, CustomKeyStoreArgs args, CustomResourceOptions? opts = null)
    public CustomKeyStore(String name, CustomKeyStoreArgs args)
public CustomKeyStore(String name, CustomKeyStoreArgs args, CustomResourceOptions options)

    type: aws:kms:CustomKeyStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_kms_custom_key_store" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CustomKeyStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomKeyStoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomKeyStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomKeyStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomKeyStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var customKeyStoreResource = new Aws.Kms.CustomKeyStore("customKeyStoreResource", new()
{
    CustomKeyStoreName = "string",
    CloudHsmClusterId = "string",
    CustomKeyStoreType = "string",
    KeyStorePassword = "string",
    Region = "string",
    TrustAnchorCertificate = "string",
    XksProxyAuthenticationCredential = new Aws.Kms.Inputs.CustomKeyStoreXksProxyAuthenticationCredentialArgs
    {
        AccessKeyId = "string",
        RawSecretAccessKey = "string",
    },
    XksProxyConnectivity = "string",
    XksProxyUriEndpoint = "string",
    XksProxyUriPath = "string",
    XksProxyVpcEndpointServiceName = "string",
});

    example, err := kms.NewCustomKeyStore(ctx, "customKeyStoreResource", &kms.CustomKeyStoreArgs{
	CustomKeyStoreName:     pulumi.String("string"),
	CloudHsmClusterId:      pulumi.String("string"),
	CustomKeyStoreType:     pulumi.String("string"),
	KeyStorePassword:       pulumi.String("string"),
	Region:                 pulumi.String("string"),
	TrustAnchorCertificate: pulumi.String("string"),
	XksProxyAuthenticationCredential: &kms.CustomKeyStoreXksProxyAuthenticationCredentialArgs{
		AccessKeyId:        pulumi.String("string"),
		RawSecretAccessKey: pulumi.String("string"),
	},
	XksProxyConnectivity:           pulumi.String("string"),
	XksProxyUriEndpoint:            pulumi.String("string"),
	XksProxyUriPath:                pulumi.String("string"),
	XksProxyVpcEndpointServiceName: pulumi.String("string"),
})

    resource "aws_kms_custom_key_store" "customKeyStoreResource" {
  lifecycle {
    create_before_destroy = true
  }
  custom_key_store_name    = "string"
  cloud_hsm_cluster_id     = "string"
  custom_key_store_type    = "string"
  key_store_password       = "string"
  region                   = "string"
  trust_anchor_certificate = "string"
  xks_proxy_authentication_credential = {
    access_key_id         = "string"
    raw_secret_access_key = "string"
  }
  xks_proxy_connectivity              = "string"
  xks_proxy_uri_endpoint              = "string"
  xks_proxy_uri_path                  = "string"
  xks_proxy_vpc_endpoint_service_name = "string"
}

    var customKeyStoreResource = new CustomKeyStore("customKeyStoreResource", CustomKeyStoreArgs.builder()
    .customKeyStoreName("string")
    .cloudHsmClusterId("string")
    .customKeyStoreType("string")
    .keyStorePassword("string")
    .region("string")
    .trustAnchorCertificate("string")
    .xksProxyAuthenticationCredential(CustomKeyStoreXksProxyAuthenticationCredentialArgs.builder()
        .accessKeyId("string")
        .rawSecretAccessKey("string")
        .build())
    .xksProxyConnectivity("string")
    .xksProxyUriEndpoint("string")
    .xksProxyUriPath("string")
    .xksProxyVpcEndpointServiceName("string")
    .build());

    custom_key_store_resource = aws.kms.CustomKeyStore("customKeyStoreResource",
    custom_key_store_name="string",
    cloud_hsm_cluster_id="string",
    custom_key_store_type="string",
    key_store_password="string",
    region="string",
    trust_anchor_certificate="string",
    xks_proxy_authentication_credential={
        "access_key_id": "string",
        "raw_secret_access_key": "string",
    },
    xks_proxy_connectivity="string",
    xks_proxy_uri_endpoint="string",
    xks_proxy_uri_path="string",
    xks_proxy_vpc_endpoint_service_name="string")

    const customKeyStoreResource = new aws.kms.CustomKeyStore("customKeyStoreResource", {
    customKeyStoreName: "string",
    cloudHsmClusterId: "string",
    customKeyStoreType: "string",
    keyStorePassword: "string",
    region: "string",
    trustAnchorCertificate: "string",
    xksProxyAuthenticationCredential: {
        accessKeyId: "string",
        rawSecretAccessKey: "string",
    },
    xksProxyConnectivity: "string",
    xksProxyUriEndpoint: "string",
    xksProxyUriPath: "string",
    xksProxyVpcEndpointServiceName: "string",
});

    type: aws:kms:CustomKeyStore
properties:
    cloudHsmClusterId: string
    customKeyStoreName: string
    customKeyStoreType: string
    keyStorePassword: string
    region: string
    trustAnchorCertificate: string
    xksProxyAuthenticationCredential:
        accessKeyId: string
        rawSecretAccessKey: string
    xksProxyConnectivity: string
    xksProxyUriEndpoint: string
    xksProxyUriPath: string
    xksProxyVpcEndpointServiceName: string

    CustomKeyStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomKeyStore resource accepts the following input properties:

    CustomKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    CloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    CustomKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    KeyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TrustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    XksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    XksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    CustomKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    CloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    CustomKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    KeyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TrustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    XksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredentialArgs
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    XksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    custom_key_store_name string

    Unique name for Custom Key Store.

    The following arguments are optional:

    cloud_hsm_cluster_id string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    custom_key_store_type string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    key_store_password string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trust_anchor_certificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xks_proxy_authentication_credential object
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xks_proxy_connectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_endpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_path string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_vpc_endpoint_service_name string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    customKeyStoreName String

    Unique name for Custom Key Store.

    The following arguments are optional:

    cloudHsmClusterId String
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreType String
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword String
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate String
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity String
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint String
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath String
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName String
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    customKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    cloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    custom_key_store_name str

    Unique name for Custom Key Store.

    The following arguments are optional:

    cloud_hsm_cluster_id str
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    custom_key_store_type str
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    key_store_password str
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trust_anchor_certificate str
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xks_proxy_authentication_credential CustomKeyStoreXksProxyAuthenticationCredentialArgs
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xks_proxy_connectivity str
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_endpoint str
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_path str
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_vpc_endpoint_service_name str
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    customKeyStoreName String

    Unique name for Custom Key Store.

    The following arguments are optional:

    cloudHsmClusterId String
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreType String
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword String
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate String
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential Property Map
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity String
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint String
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath String
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName String
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomKeyStore resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomKeyStore Resource

    Get an existing CustomKeyStore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomKeyStoreState, opts?: CustomResourceOptions): CustomKeyStore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_hsm_cluster_id: Optional[str] = None,
        custom_key_store_name: Optional[str] = None,
        custom_key_store_type: Optional[str] = None,
        key_store_password: Optional[str] = None,
        region: Optional[str] = None,
        trust_anchor_certificate: Optional[str] = None,
        xks_proxy_authentication_credential: Optional[CustomKeyStoreXksProxyAuthenticationCredentialArgs] = None,
        xks_proxy_connectivity: Optional[str] = None,
        xks_proxy_uri_endpoint: Optional[str] = None,
        xks_proxy_uri_path: Optional[str] = None,
        xks_proxy_vpc_endpoint_service_name: Optional[str] = None) -> CustomKeyStore
    func GetCustomKeyStore(ctx *Context, name string, id IDInput, state *CustomKeyStoreState, opts ...ResourceOption) (*CustomKeyStore, error)
    public static CustomKeyStore Get(string name, Input<string> id, CustomKeyStoreState? state, CustomResourceOptions? opts = null)
    public static CustomKeyStore get(String name, Output<String> id, CustomKeyStoreState state, CustomResourceOptions options)
    resources:  _:    type: aws:kms:CustomKeyStore    get:      id: ${id}
    import {
  to = aws_kms_custom_key_store.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    CustomKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    CustomKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    KeyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TrustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    XksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    XksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    CloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    CustomKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    CustomKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    KeyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TrustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    XksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredentialArgs
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    XksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    XksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    cloud_hsm_cluster_id string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    custom_key_store_name string

    Unique name for Custom Key Store.

    The following arguments are optional:

    custom_key_store_type string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    key_store_password string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trust_anchor_certificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xks_proxy_authentication_credential object
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xks_proxy_connectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_endpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_path string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_vpc_endpoint_service_name string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    cloudHsmClusterId String
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreName String

    Unique name for Custom Key Store.

    The following arguments are optional:

    customKeyStoreType String
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword String
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate String
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity String
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint String
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath String
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName String
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    cloudHsmClusterId string
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreName string

    Unique name for Custom Key Store.

    The following arguments are optional:

    customKeyStoreType string
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword string
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate string
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential CustomKeyStoreXksProxyAuthenticationCredential
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity string
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint string
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath string
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName string
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    cloud_hsm_cluster_id str
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    custom_key_store_name str

    Unique name for Custom Key Store.

    The following arguments are optional:

    custom_key_store_type str
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    key_store_password str
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trust_anchor_certificate str
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xks_proxy_authentication_credential CustomKeyStoreXksProxyAuthenticationCredentialArgs
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xks_proxy_connectivity str
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_endpoint str
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_uri_path str
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xks_proxy_vpc_endpoint_service_name str
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.
    cloudHsmClusterId String
    Cluster ID of CloudHSM. Applies when customKeyStoreType is AWS_CLOUDHSM.
    customKeyStoreName String

    Unique name for Custom Key Store.

    The following arguments are optional:

    customKeyStoreType String
    Type of key store to create. Valid values are AWS_CLOUDHSM and EXTERNAL_KEY_STORE. If omitted, AWS will default the value to AWS_CLOUDHSM.
    keyStorePassword String
    Password for the kmsuser of an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    trustAnchorCertificate String
    Certificate for an AWS CloudHSM key store. Applies when customKeyStoreType is AWS_CLOUDHSM.
    xksProxyAuthenticationCredential Property Map
    Authentication credential for the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE. See xksProxyAuthenticationCredential block below.
    xksProxyConnectivity String
    How AWS KMS communicates with the external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriEndpoint String
    Endpoint that AWS KMS uses to send requests to the external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyUriPath String
    Base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. Applies when customKeyStoreType is EXTERNAL_KEY_STORE.
    xksProxyVpcEndpointServiceName String
    Name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). Applies when customKeyStoreType is EXTERNAL_KEY_STORE and required when xksProxyConnectivity is VPC_ENDPOINT_SERVICE.

    Supporting Types

    CustomKeyStoreXksProxyAuthenticationCredential, CustomKeyStoreXksProxyAuthenticationCredentialArgs

    AccessKeyId string
    Unique identifier for the raw secret access key.
    RawSecretAccessKey string
    Secret string of 43-64 characters.
    AccessKeyId string
    Unique identifier for the raw secret access key.
    RawSecretAccessKey string
    Secret string of 43-64 characters.
    access_key_id string
    Unique identifier for the raw secret access key.
    raw_secret_access_key string
    Secret string of 43-64 characters.
    accessKeyId String
    Unique identifier for the raw secret access key.
    rawSecretAccessKey String
    Secret string of 43-64 characters.
    accessKeyId string
    Unique identifier for the raw secret access key.
    rawSecretAccessKey string
    Secret string of 43-64 characters.
    access_key_id str
    Unique identifier for the raw secret access key.
    raw_secret_access_key str
    Secret string of 43-64 characters.
    accessKeyId String
    Unique identifier for the raw secret access key.
    rawSecretAccessKey String
    Secret string of 43-64 characters.

    Import

    Using pulumi import, import KMS (Key Management) Custom Key Store using the id. For example:

    $ pulumi import aws:kms/customKeyStore:CustomKeyStore example cks-5ebd4ef395a96288e

    To learn more about importing existing cloud resources, see Importing resources.

    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.53.0
    published on Monday, Nov 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial