1. Packages
  2. Aiven Provider
  3. API Docs
  4. Cmk
Aiven v6.50.0 published on Friday, Feb 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.Cmk

aiven logo
Aiven v6.50.0 published on Friday, Feb 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Creates and manages customer managed keys (CMKs) for encrypting service data. Use your own CMKs from your cloud provider’s key management service (KMS) to encrypt data for all services in an Aiven project. This gives you complete control over your encryption keys, meaning you can independently manage the key lifecycle and access policies.

    This resource is in the beta stage and may change without notice. Set the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource.

    Warning If you remove a CMK, the services linked to the key will stop working. Migrate the services to another CMK or an Aiven-managed key before removing the CMK.

    Example Usage

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

const exampleUser = new aiven.Cmk("example_user", {
    project: aivenProjectName,
    resource: cmkResource,
    cmkProvider: "gcp",
    defaultCmk: false,
});

    import pulumi
import pulumi_aiven as aiven

example_user = aiven.Cmk("example_user",
    project=aiven_project_name,
    resource=cmk_resource,
    cmk_provider="gcp",
    default_cmk=False)

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewCmk(ctx, "example_user", &aiven.CmkArgs{
			Project:     pulumi.Any(aivenProjectName),
			Resource:    pulumi.Any(cmkResource),
			CmkProvider: pulumi.String("gcp"),
			DefaultCmk:  pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleUser = new Aiven.Cmk("example_user", new()
    {
        Project = aivenProjectName,
        Resource = cmkResource,
        CmkProvider = "gcp",
        DefaultCmk = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Cmk;
import com.pulumi.aiven.CmkArgs;
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) {
        var exampleUser = new Cmk("exampleUser", CmkArgs.builder()
            .project(aivenProjectName)
            .resource(cmkResource)
            .cmkProvider("gcp")
            .defaultCmk(false)
            .build());

    }
}

    resources:
  exampleUser:
    type: aiven:Cmk
    name: example_user
    properties:
      project: ${aivenProjectName}
      resource: ${cmkResource}
      cmkProvider: gcp
      defaultCmk: false

    Create Cmk Resource

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

    Constructor syntax

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

@overload
def Cmk(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        cmk_provider: Optional[str] = None,
        default_cmk: Optional[bool] = None,
        project: Optional[str] = None,
        resource: Optional[str] = None,
        timeouts: Optional[CmkTimeoutsArgs] = None)
    func NewCmk(ctx *Context, name string, args CmkArgs, opts ...ResourceOption) (*Cmk, error)
    public Cmk(string name, CmkArgs args, CustomResourceOptions? opts = null)
    public Cmk(String name, CmkArgs args)
public Cmk(String name, CmkArgs args, CustomResourceOptions options)

    type: aiven:Cmk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CmkArgs
    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 CmkArgs
    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 CmkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CmkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CmkArgs
    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 cmkResource = new Aiven.Cmk("cmkResource", new()
{
    CmkProvider = "string",
    DefaultCmk = false,
    Project = "string",
    Resource = "string",
    Timeouts = new Aiven.Inputs.CmkTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := aiven.NewCmk(ctx, "cmkResource", &aiven.CmkArgs{
	CmkProvider: pulumi.String("string"),
	DefaultCmk:  pulumi.Bool(false),
	Project:     pulumi.String("string"),
	Resource:    pulumi.String("string"),
	Timeouts: &aiven.CmkTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var cmkResource = new Cmk("cmkResource", CmkArgs.builder()
    .cmkProvider("string")
    .defaultCmk(false)
    .project("string")
    .resource("string")
    .timeouts(CmkTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    cmk_resource = aiven.Cmk("cmkResource",
    cmk_provider="string",
    default_cmk=False,
    project="string",
    resource="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const cmkResource = new aiven.Cmk("cmkResource", {
    cmkProvider: "string",
    defaultCmk: false,
    project: "string",
    resource: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: aiven:Cmk
properties:
    cmkProvider: string
    defaultCmk: false
    project: string
    resource: string
    timeouts:
        create: string
        delete: string
        read: string
        update: string

    Cmk 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 Cmk resource accepts the following input properties:

    CmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    DefaultCmk bool
    Mark the created CMK as default for all newly created services.
    Project string
    Project name. Changing this property forces recreation of the resource.
    Resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    Timeouts CmkTimeouts
    CmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    DefaultCmk bool
    Mark the created CMK as default for all newly created services.
    Project string
    Project name. Changing this property forces recreation of the resource.
    Resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    Timeouts CmkTimeoutsArgs
    cmkProvider String
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    defaultCmk Boolean
    Mark the created CMK as default for all newly created services.
    project String
    Project name. Changing this property forces recreation of the resource.
    resource String
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    timeouts CmkTimeouts
    cmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    defaultCmk boolean
    Mark the created CMK as default for all newly created services.
    project string
    Project name. Changing this property forces recreation of the resource.
    resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    timeouts CmkTimeouts
    cmk_provider str
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    default_cmk bool
    Mark the created CMK as default for all newly created services.
    project str
    Project name. Changing this property forces recreation of the resource.
    resource str
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    timeouts CmkTimeoutsArgs
    cmkProvider String
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    defaultCmk Boolean
    Mark the created CMK as default for all newly created services.
    project String
    Project name. Changing this property forces recreation of the resource.
    resource String
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    timeouts Property Map

    Outputs

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

    CmkId string
    Customer Managed Key identifier (CMK ID).
    CreatedAt string
    Created At.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status. The possible values are current, deleted and old.
    UpdatedAt string
    Updated At.
    CmkId string
    Customer Managed Key identifier (CMK ID).
    CreatedAt string
    Created At.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status. The possible values are current, deleted and old.
    UpdatedAt string
    Updated At.
    cmkId String
    Customer Managed Key identifier (CMK ID).
    createdAt String
    Created At.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status. The possible values are current, deleted and old.
    updatedAt String
    Updated At.
    cmkId string
    Customer Managed Key identifier (CMK ID).
    createdAt string
    Created At.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status. The possible values are current, deleted and old.
    updatedAt string
    Updated At.
    cmk_id str
    Customer Managed Key identifier (CMK ID).
    created_at str
    Created At.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status. The possible values are current, deleted and old.
    updated_at str
    Updated At.
    cmkId String
    Customer Managed Key identifier (CMK ID).
    createdAt String
    Created At.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status. The possible values are current, deleted and old.
    updatedAt String
    Updated At.

    Look up Existing Cmk Resource

    Get an existing Cmk 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?: CmkState, opts?: CustomResourceOptions): Cmk
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cmk_id: Optional[str] = None,
        cmk_provider: Optional[str] = None,
        created_at: Optional[str] = None,
        default_cmk: Optional[bool] = None,
        project: Optional[str] = None,
        resource: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[CmkTimeoutsArgs] = None,
        updated_at: Optional[str] = None) -> Cmk
    func GetCmk(ctx *Context, name string, id IDInput, state *CmkState, opts ...ResourceOption) (*Cmk, error)
    public static Cmk Get(string name, Input<string> id, CmkState? state, CustomResourceOptions? opts = null)
    public static Cmk get(String name, Output<String> id, CmkState state, CustomResourceOptions options)
    resources:  _:    type: aiven:Cmk    get:      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:
    CmkId string
    Customer Managed Key identifier (CMK ID).
    CmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    CreatedAt string
    Created At.
    DefaultCmk bool
    Mark the created CMK as default for all newly created services.
    Project string
    Project name. Changing this property forces recreation of the resource.
    Resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    Status string
    Status. The possible values are current, deleted and old.
    Timeouts CmkTimeouts
    UpdatedAt string
    Updated At.
    CmkId string
    Customer Managed Key identifier (CMK ID).
    CmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    CreatedAt string
    Created At.
    DefaultCmk bool
    Mark the created CMK as default for all newly created services.
    Project string
    Project name. Changing this property forces recreation of the resource.
    Resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    Status string
    Status. The possible values are current, deleted and old.
    Timeouts CmkTimeoutsArgs
    UpdatedAt string
    Updated At.
    cmkId String
    Customer Managed Key identifier (CMK ID).
    cmkProvider String
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    createdAt String
    Created At.
    defaultCmk Boolean
    Mark the created CMK as default for all newly created services.
    project String
    Project name. Changing this property forces recreation of the resource.
    resource String
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    status String
    Status. The possible values are current, deleted and old.
    timeouts CmkTimeouts
    updatedAt String
    Updated At.
    cmkId string
    Customer Managed Key identifier (CMK ID).
    cmkProvider string
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    createdAt string
    Created At.
    defaultCmk boolean
    Mark the created CMK as default for all newly created services.
    project string
    Project name. Changing this property forces recreation of the resource.
    resource string
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    status string
    Status. The possible values are current, deleted and old.
    timeouts CmkTimeouts
    updatedAt string
    Updated At.
    cmk_id str
    Customer Managed Key identifier (CMK ID).
    cmk_provider str
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    created_at str
    Created At.
    default_cmk bool
    Mark the created CMK as default for all newly created services.
    project str
    Project name. Changing this property forces recreation of the resource.
    resource str
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    status str
    Status. The possible values are current, deleted and old.
    timeouts CmkTimeoutsArgs
    updated_at str
    Updated At.
    cmkId String
    Customer Managed Key identifier (CMK ID).
    cmkProvider String
    The cloud provider hosting the key management service (KMS). The possible values are aws, gcp and oci. Changing this property forces recreation of the resource.
    createdAt String
    Created At.
    defaultCmk Boolean
    Mark the created CMK as default for all newly created services.
    project String
    Project name. Changing this property forces recreation of the resource.
    resource String
    The unique identifier for the CMK in the cloud provider's KMS. In AWS, this is the Key ARN; in Google Cloud the Resource Name; and in Oracle Cloud the Key OCID. Maximum length: 512. Changing this property forces recreation of the resource.
    status String
    Status. The possible values are current, deleted and old.
    timeouts Property Map
    updatedAt String
    Updated At.

    Supporting Types

    CmkTimeouts, CmkTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    $ pulumi import aiven:index/cmk:Cmk example PROJECT/CMK_ID

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

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.50.0 published on Friday, Feb 27, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven
      Meet Neo: Your AI Platform Teammate