Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. MongodbInstanceTransparentDataEncryption
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.MongodbInstanceTransparentDataEncryption

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to enable mongodb transparent data encryption

    Example Usage

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

const encryption = new tencentcloud.MongodbInstanceTransparentDataEncryption("encryption", {
    instanceId: "cmgo-xxxxxx",
    kmsRegion: "ap-guangzhou",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

encryption = tencentcloud.MongodbInstanceTransparentDataEncryption("encryption",
    instance_id="cmgo-xxxxxx",
    kms_region="ap-guangzhou")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewMongodbInstanceTransparentDataEncryption(ctx, "encryption", &tencentcloud.MongodbInstanceTransparentDataEncryptionArgs{
			InstanceId: pulumi.String("cmgo-xxxxxx"),
			KmsRegion:  pulumi.String("ap-guangzhou"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var encryption = new Tencentcloud.MongodbInstanceTransparentDataEncryption("encryption", new()
    {
        InstanceId = "cmgo-xxxxxx",
        KmsRegion = "ap-guangzhou",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.MongodbInstanceTransparentDataEncryption;
import com.pulumi.tencentcloud.MongodbInstanceTransparentDataEncryptionArgs;
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 encryption = new MongodbInstanceTransparentDataEncryption("encryption", MongodbInstanceTransparentDataEncryptionArgs.builder()
            .instanceId("cmgo-xxxxxx")
            .kmsRegion("ap-guangzhou")
            .build());

    }
}

    resources:
  encryption:
    type: tencentcloud:MongodbInstanceTransparentDataEncryption
    properties:
      instanceId: cmgo-xxxxxx
      kmsRegion: ap-guangzhou

    Create MongodbInstanceTransparentDataEncryption Resource

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

    Constructor syntax

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

@overload
def MongodbInstanceTransparentDataEncryption(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             instance_id: Optional[str] = None,
                                             kms_region: Optional[str] = None,
                                             key_id: Optional[str] = None,
                                             mongodb_instance_transparent_data_encryption_id: Optional[str] = None)
    func NewMongodbInstanceTransparentDataEncryption(ctx *Context, name string, args MongodbInstanceTransparentDataEncryptionArgs, opts ...ResourceOption) (*MongodbInstanceTransparentDataEncryption, error)
    public MongodbInstanceTransparentDataEncryption(string name, MongodbInstanceTransparentDataEncryptionArgs args, CustomResourceOptions? opts = null)
    public MongodbInstanceTransparentDataEncryption(String name, MongodbInstanceTransparentDataEncryptionArgs args)
public MongodbInstanceTransparentDataEncryption(String name, MongodbInstanceTransparentDataEncryptionArgs args, CustomResourceOptions options)

    type: tencentcloud:MongodbInstanceTransparentDataEncryption
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 MongodbInstanceTransparentDataEncryptionArgs
    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 MongodbInstanceTransparentDataEncryptionArgs
    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 MongodbInstanceTransparentDataEncryptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongodbInstanceTransparentDataEncryptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongodbInstanceTransparentDataEncryptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    InstanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    KmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    KeyId string
    MongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    InstanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    KmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    KeyId string
    MongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    instanceId String
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    kmsRegion String
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    keyId String
    mongodbInstanceTransparentDataEncryptionId String
    ID of the resource.
    instanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    kmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    keyId string
    mongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    instance_id str
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    kms_region str
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    key_id str
    mongodb_instance_transparent_data_encryption_id str
    ID of the resource.
    instanceId String
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    kmsRegion String
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    keyId String
    mongodbInstanceTransparentDataEncryptionId String
    ID of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    KeyInfoLists List<MongodbInstanceTransparentDataEncryptionKeyInfoList>
    List of bound keys.
    TransparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyInfoLists []MongodbInstanceTransparentDataEncryptionKeyInfoList
    List of bound keys.
    TransparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    id String
    The provider-assigned unique ID for this managed resource.
    keyInfoLists List<MongodbInstanceTransparentDataEncryptionKeyInfoList>
    List of bound keys.
    transparentDataEncryptionStatus String
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    id string
    The provider-assigned unique ID for this managed resource.
    keyInfoLists MongodbInstanceTransparentDataEncryptionKeyInfoList[]
    List of bound keys.
    transparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    id str
    The provider-assigned unique ID for this managed resource.
    key_info_lists Sequence[MongodbInstanceTransparentDataEncryptionKeyInfoList]
    List of bound keys.
    transparent_data_encryption_status str
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    id String
    The provider-assigned unique ID for this managed resource.
    keyInfoLists List<Property Map>
    List of bound keys.
    transparentDataEncryptionStatus String
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.

    Look up Existing MongodbInstanceTransparentDataEncryption Resource

    Get an existing MongodbInstanceTransparentDataEncryption 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?: MongodbInstanceTransparentDataEncryptionState, opts?: CustomResourceOptions): MongodbInstanceTransparentDataEncryption
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_id: Optional[str] = None,
        key_id: Optional[str] = None,
        key_info_lists: Optional[Sequence[MongodbInstanceTransparentDataEncryptionKeyInfoListArgs]] = None,
        kms_region: Optional[str] = None,
        mongodb_instance_transparent_data_encryption_id: Optional[str] = None,
        transparent_data_encryption_status: Optional[str] = None) -> MongodbInstanceTransparentDataEncryption
    func GetMongodbInstanceTransparentDataEncryption(ctx *Context, name string, id IDInput, state *MongodbInstanceTransparentDataEncryptionState, opts ...ResourceOption) (*MongodbInstanceTransparentDataEncryption, error)
    public static MongodbInstanceTransparentDataEncryption Get(string name, Input<string> id, MongodbInstanceTransparentDataEncryptionState? state, CustomResourceOptions? opts = null)
    public static MongodbInstanceTransparentDataEncryption get(String name, Output<String> id, MongodbInstanceTransparentDataEncryptionState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:MongodbInstanceTransparentDataEncryption    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:
    InstanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    KeyId string
    KeyInfoLists List<MongodbInstanceTransparentDataEncryptionKeyInfoList>
    List of bound keys.
    KmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    MongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    TransparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    InstanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    KeyId string
    KeyInfoLists []MongodbInstanceTransparentDataEncryptionKeyInfoListArgs
    List of bound keys.
    KmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    MongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    TransparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    instanceId String
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    keyId String
    keyInfoLists List<MongodbInstanceTransparentDataEncryptionKeyInfoList>
    List of bound keys.
    kmsRegion String
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    mongodbInstanceTransparentDataEncryptionId String
    ID of the resource.
    transparentDataEncryptionStatus String
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    instanceId string
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    keyId string
    keyInfoLists MongodbInstanceTransparentDataEncryptionKeyInfoList[]
    List of bound keys.
    kmsRegion string
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    mongodbInstanceTransparentDataEncryptionId string
    ID of the resource.
    transparentDataEncryptionStatus string
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    instance_id str
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    key_id str
    key_info_lists Sequence[MongodbInstanceTransparentDataEncryptionKeyInfoListArgs]
    List of bound keys.
    kms_region str
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    mongodb_instance_transparent_data_encryption_id str
    ID of the resource.
    transparent_data_encryption_status str
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.
    instanceId String
    Instance ID, for example: cmgo-p8vn ***. Currently supported general versions include: 4.4 and 5.0, but the cloud disk version is not currently supported.
    keyId String
    keyInfoLists List<Property Map>
    List of bound keys.
    kmsRegion String
    The region where the Key Management Service (KMS) serves, such as ap-shanghai.
    mongodbInstanceTransparentDataEncryptionId String
    ID of the resource.
    transparentDataEncryptionStatus String
    Represents whether transparent encryption is turned on. Valid values:

    • close: Not opened;
    • open: It has been opened.

    Supporting Types

    MongodbInstanceTransparentDataEncryptionKeyInfoList, MongodbInstanceTransparentDataEncryptionKeyInfoListArgs

    CreateTime string
    Instance and key binding time.
    KeyId string
    KeyName string
    Master key name.
    KeyOrigin string
    Key origin.
    KeyUsage string
    Purpose of the key.
    Status string
    Key status.
    CreateTime string
    Instance and key binding time.
    KeyId string
    KeyName string
    Master key name.
    KeyOrigin string
    Key origin.
    KeyUsage string
    Purpose of the key.
    Status string
    Key status.
    createTime String
    Instance and key binding time.
    keyId String
    keyName String
    Master key name.
    keyOrigin String
    Key origin.
    keyUsage String
    Purpose of the key.
    status String
    Key status.
    createTime string
    Instance and key binding time.
    keyId string
    keyName string
    Master key name.
    keyOrigin string
    Key origin.
    keyUsage string
    Purpose of the key.
    status string
    Key status.
    create_time str
    Instance and key binding time.
    key_id str
    key_name str
    Master key name.
    key_origin str
    Key origin.
    key_usage str
    Purpose of the key.
    status str
    Key status.
    createTime String
    Instance and key binding time.
    keyId String
    keyName String
    Master key name.
    keyOrigin String
    Key origin.
    keyUsage String
    Purpose of the key.
    status String
    Key status.

    Import

    mongodb transparent data encryption can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/mongodbInstanceTransparentDataEncryption:MongodbInstanceTransparentDataEncryption encryption ${instanceId}

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud