1. Packages
  2. Packages
  3. Clickhouse
  4. API Docs
  5. ServiceTransparentDataEncryptionKey
  6. Association
Viewing docs for Clickhouse v2.0.1
published on Thursday, May 21, 2026 by pulumiverse
clickhouse logo
Viewing docs for Clickhouse v2.0.1
published on Thursday, May 21, 2026 by pulumiverse

    You can use the clickhouse_service_transparent_data_encryption_key_association resource to associate your own Encryption Key with a Clickhouse Service with the Transparent Data Encryption (TDE) feature enabled. Please note that this feature requires an organization with the Enterprise plan.

    Create Association Resource

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

    Constructor syntax

    new Association(name: string, args: AssociationArgs, opts?: CustomResourceOptions);
    @overload
    def Association(resource_name: str,
                    args: AssociationArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Association(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    key_id: Optional[str] = None,
                    service_id: Optional[str] = None)
    func NewAssociation(ctx *Context, name string, args AssociationArgs, opts ...ResourceOption) (*Association, error)
    public Association(string name, AssociationArgs args, CustomResourceOptions? opts = null)
    public Association(String name, AssociationArgs args)
    public Association(String name, AssociationArgs args, CustomResourceOptions options)
    
    type: clickhouse:ServiceTransparentDataEncryptionKey:Association
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "clickhouse_servicetransparentdataencryptionkey_association" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AssociationArgs
    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 AssociationArgs
    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 AssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssociationArgs
    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 associationResource = new Clickhouse.ServiceTransparentDataEncryptionKey.Association("associationResource", new()
    {
        KeyId = "string",
        ServiceId = "string",
    });
    
    example, err := servicetransparentdataencryptionkey.NewAssociation(ctx, "associationResource", &servicetransparentdataencryptionkey.AssociationArgs{
    	KeyId:     pulumi.String("string"),
    	ServiceId: pulumi.String("string"),
    })
    
    resource "clickhouse_servicetransparentdataencryptionkey_association" "associationResource" {
      key_id     = "string"
      service_id = "string"
    }
    
    var associationResource = new Association("associationResource", AssociationArgs.builder()
        .keyId("string")
        .serviceId("string")
        .build());
    
    association_resource = clickhouse.servicetransparentdataencryptionkey.Association("associationResource",
        key_id="string",
        service_id="string")
    
    const associationResource = new clickhouse.servicetransparentdataencryptionkey.Association("associationResource", {
        keyId: "string",
        serviceId: "string",
    });
    
    type: clickhouse:ServiceTransparentDataEncryptionKey:Association
    properties:
        keyId: string
        serviceId: string
    

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

    KeyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    ServiceId string
    ClickHouse Service ID
    KeyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    ServiceId string
    ClickHouse Service ID
    key_id string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    service_id string
    ClickHouse Service ID
    keyId String
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId String
    ClickHouse Service ID
    keyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId string
    ClickHouse Service ID
    key_id str
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    service_id str
    ClickHouse Service ID
    keyId String
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId String
    ClickHouse Service ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Association 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 Association Resource

    Get an existing Association 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?: AssociationState, opts?: CustomResourceOptions): Association
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            key_id: Optional[str] = None,
            service_id: Optional[str] = None) -> Association
    func GetAssociation(ctx *Context, name string, id IDInput, state *AssociationState, opts ...ResourceOption) (*Association, error)
    public static Association Get(string name, Input<string> id, AssociationState? state, CustomResourceOptions? opts = null)
    public static Association get(String name, Output<String> id, AssociationState state, CustomResourceOptions options)
    resources:  _:    type: clickhouse:ServiceTransparentDataEncryptionKey:Association    get:      id: ${id}
    import {
      to = clickhouse_servicetransparentdataencryptionkey_association.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:
    KeyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    ServiceId string
    ClickHouse Service ID
    KeyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    ServiceId string
    ClickHouse Service ID
    key_id string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    service_id string
    ClickHouse Service ID
    keyId String
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId String
    ClickHouse Service ID
    keyId string
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId string
    ClickHouse Service ID
    key_id str
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    service_id str
    ClickHouse Service ID
    keyId String
    ID of the Encryption key to use for data encryption. Must be an ARN for AWS services or a Key Resource Path for GCP services.
    serviceId String
    ClickHouse Service ID

    Import

    The pulumi import command can be used, for example:

    Endpoint Attachments can be imported by specifying the clickhouse service UUID

    $ pulumi import clickhouse:ServiceTransparentDataEncryptionKey/association:Association example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    

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

    Package Details

    Repository
    clickhouse pulumiverse/pulumi-clickhouse
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the clickhouse Terraform Provider.
    clickhouse logo
    Viewing docs for Clickhouse v2.0.1
    published on Thursday, May 21, 2026 by pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial