Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. EncryptionAtRestPrivateEndpoint
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.EncryptionAtRestPrivateEndpoint

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Resource: mongodbatlas.EncryptionAtRestPrivateEndpoint

mongodbatlas.EncryptionAtRestPrivateEndpoint provides a resource for managing a private endpoint used for encryption at rest with customer-managed keys. This ensures all traffic between Atlas and customer key management systems take place over private network interfaces.

NOTE: As a prerequisite to configuring a private endpoint for Azure Key Vault or AWS KMS, the corresponding mongodbatlas.EncryptionAtRest resource has to be adjusted by configuring to true azure_key_vault_config.require_private_networking or aws_kms_config.require_private_networking, respectively. This attribute should be updated in place, ensuring the customer-managed keys encryption is never disabled.

NOTE: This resource does not support update operations. To modify values of a private endpoint the existing resource must be deleted and a new one can be created with the modified values.

Example Usage

S

NOTE: Only Azure Key Vault with Azure Private Link and AWS KMS over AWS PrivateLink is supported at this time.

To learn more about existing limitations, see Manage Customer Keys with Azure Key Vault Over Private Endpoints.

Make sure to reference the complete example section for detailed steps and considerations.

import * as pulumi from "@pulumi/pulumi";
import * as azapi from "@pulumi/azapi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const ear = new mongodbatlas.EncryptionAtRest("ear", {
    projectId: atlasProjectId,
    azureKeyVaultConfig: {
        requirePrivateNetworking: true,
        enabled: true,
        azureEnvironment: "AZURE",
        tenantId: azureTenantId,
        subscriptionId: azureSubscriptionId,
        clientId: azureClientId,
        secret: azureClientSecret,
        resourceGroupName: azureResourceGroupName,
        keyVaultName: azureKeyVaultName,
        keyIdentifier: azureKeyIdentifier,
    },
});
// Creates private endpoint
const endpoint = new mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint", {
    projectId: ear.projectId,
    cloudProvider: "AZURE",
    regionName: azureRegionName,
});
const keyVaultResourceId = `/subscriptions/${azureSubscriptionId}/resourceGroups/${azureResourceGroupName}/providers/Microsoft.KeyVault/vaults/${azureKeyVaultName}`;
// Approves private endpoint connection from Azure Key Vault
const approval = new azapi.index.UpdateResource("approval", {
    type: "Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01",
    name: endpoint.privateEndpointConnectionName,
    parentId: keyVaultResourceId,
    body: JSON.stringify({
        properties: {
            privateLinkServiceConnectionState: {
                description: "Approved via Terraform",
                status: "Approved",
            },
        },
    }),
});
Copy
import pulumi
import json
import pulumi_azapi as azapi
import pulumi_mongodbatlas as mongodbatlas

ear = mongodbatlas.EncryptionAtRest("ear",
    project_id=atlas_project_id,
    azure_key_vault_config={
        "require_private_networking": True,
        "enabled": True,
        "azure_environment": "AZURE",
        "tenant_id": azure_tenant_id,
        "subscription_id": azure_subscription_id,
        "client_id": azure_client_id,
        "secret": azure_client_secret,
        "resource_group_name": azure_resource_group_name,
        "key_vault_name": azure_key_vault_name,
        "key_identifier": azure_key_identifier,
    })
# Creates private endpoint
endpoint = mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint",
    project_id=ear.project_id,
    cloud_provider="AZURE",
    region_name=azure_region_name)
key_vault_resource_id = f"/subscriptions/{azure_subscription_id}/resourceGroups/{azure_resource_group_name}/providers/Microsoft.KeyVault/vaults/{azure_key_vault_name}"
# Approves private endpoint connection from Azure Key Vault
approval = azapi.index.UpdateResource("approval",
    type=Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01,
    name=endpoint.private_endpoint_connection_name,
    parent_id=key_vault_resource_id,
    body=json.dumps({
        properties: {
            privateLinkServiceConnectionState: {
                description: Approved via Terraform,
                status: Approved,
            },
        },
    }))
Copy
package main

import (
	"encoding/json"
	"fmt"

	"github.com/pulumi/pulumi-azapi/sdk/go/azapi"
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ear, err := mongodbatlas.NewEncryptionAtRest(ctx, "ear", &mongodbatlas.EncryptionAtRestArgs{
ProjectId: pulumi.Any(atlasProjectId),
AzureKeyVaultConfig: &mongodbatlas.EncryptionAtRestAzureKeyVaultConfigArgs{
RequirePrivateNetworking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
AzureEnvironment: pulumi.String("AZURE"),
TenantId: pulumi.Any(azureTenantId),
SubscriptionId: pulumi.Any(azureSubscriptionId),
ClientId: pulumi.Any(azureClientId),
Secret: pulumi.Any(azureClientSecret),
ResourceGroupName: pulumi.Any(azureResourceGroupName),
KeyVaultName: pulumi.Any(azureKeyVaultName),
KeyIdentifier: pulumi.Any(azureKeyIdentifier),
},
})
if err != nil {
return err
}
// Creates private endpoint
endpoint, err := mongodbatlas.NewEncryptionAtRestPrivateEndpoint(ctx, "endpoint", &mongodbatlas.EncryptionAtRestPrivateEndpointArgs{
ProjectId: ear.ProjectId,
CloudProvider: pulumi.String("AZURE"),
RegionName: pulumi.Any(azureRegionName),
})
if err != nil {
return err
}
keyVaultResourceId := fmt.Sprintf("/subscriptions/%v/resourceGroups/%v/providers/Microsoft.KeyVault/vaults/%v", azureSubscriptionId, azureResourceGroupName, azureKeyVaultName);
// Approves private endpoint connection from Azure Key Vault
_, err = azapi.NewUpdateResource(ctx, "approval", &azapi.UpdateResourceArgs{
Type: "Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01",
Name: endpoint.PrivateEndpointConnectionName,
ParentId: keyVaultResourceId,
Body: %!v(PANIC=Format method: fatal: An assertion has failed: unlowered function toJSON),
})
if err != nil {
return err
}
return nil
})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Azapi = Pulumi.Azapi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var ear = new Mongodbatlas.EncryptionAtRest("ear", new()
    {
        ProjectId = atlasProjectId,
        AzureKeyVaultConfig = new Mongodbatlas.Inputs.EncryptionAtRestAzureKeyVaultConfigArgs
        {
            RequirePrivateNetworking = true,
            Enabled = true,
            AzureEnvironment = "AZURE",
            TenantId = azureTenantId,
            SubscriptionId = azureSubscriptionId,
            ClientId = azureClientId,
            Secret = azureClientSecret,
            ResourceGroupName = azureResourceGroupName,
            KeyVaultName = azureKeyVaultName,
            KeyIdentifier = azureKeyIdentifier,
        },
    });

    // Creates private endpoint
    var endpoint = new Mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint", new()
    {
        ProjectId = ear.ProjectId,
        CloudProvider = "AZURE",
        RegionName = azureRegionName,
    });

    var keyVaultResourceId = $"/subscriptions/{azureSubscriptionId}/resourceGroups/{azureResourceGroupName}/providers/Microsoft.KeyVault/vaults/{azureKeyVaultName}";

    // Approves private endpoint connection from Azure Key Vault
    var approval = new Azapi.Index.UpdateResource("approval", new()
    {
        Type = "Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01",
        Name = endpoint.PrivateEndpointConnectionName,
        ParentId = keyVaultResourceId,
        Body = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["properties"] = new Dictionary<string, object?>
            {
                ["privateLinkServiceConnectionState"] = new Dictionary<string, object?>
                {
                    ["description"] = "Approved via Terraform",
                    ["status"] = "Approved",
                },
            },
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.EncryptionAtRest;
import com.pulumi.mongodbatlas.EncryptionAtRestArgs;
import com.pulumi.mongodbatlas.inputs.EncryptionAtRestAzureKeyVaultConfigArgs;
import com.pulumi.mongodbatlas.EncryptionAtRestPrivateEndpoint;
import com.pulumi.mongodbatlas.EncryptionAtRestPrivateEndpointArgs;
import com.pulumi.azapi.updateResource;
import com.pulumi.azapi.UpdateResourceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 ear = new EncryptionAtRest("ear", EncryptionAtRestArgs.builder()
            .projectId(atlasProjectId)
            .azureKeyVaultConfig(EncryptionAtRestAzureKeyVaultConfigArgs.builder()
                .requirePrivateNetworking(true)
                .enabled(true)
                .azureEnvironment("AZURE")
                .tenantId(azureTenantId)
                .subscriptionId(azureSubscriptionId)
                .clientId(azureClientId)
                .secret(azureClientSecret)
                .resourceGroupName(azureResourceGroupName)
                .keyVaultName(azureKeyVaultName)
                .keyIdentifier(azureKeyIdentifier)
                .build())
            .build());

        // Creates private endpoint
        var endpoint = new EncryptionAtRestPrivateEndpoint("endpoint", EncryptionAtRestPrivateEndpointArgs.builder()
            .projectId(ear.projectId())
            .cloudProvider("AZURE")
            .regionName(azureRegionName)
            .build());

        final var keyVaultResourceId = String.format("/subscriptions/%s/resourceGroups/%s/providers/Microsoft.KeyVault/vaults/%s", azureSubscriptionId,azureResourceGroupName,azureKeyVaultName);

        // Approves private endpoint connection from Azure Key Vault
        var approval = new UpdateResource("approval", UpdateResourceArgs.builder()
            .type("Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01")
            .name(endpoint.privateEndpointConnectionName())
            .parentId(keyVaultResourceId)
            .body(serializeJson(
                jsonObject(
                    jsonProperty("properties", jsonObject(
                        jsonProperty("privateLinkServiceConnectionState", jsonObject(
                            jsonProperty("description", "Approved via Terraform"),
                            jsonProperty("status", "Approved")
                        ))
                    ))
                )))
            .build());

    }
}
Copy
resources:
  ear:
    type: mongodbatlas:EncryptionAtRest
    properties:
      projectId: ${atlasProjectId}
      azureKeyVaultConfig:
        requirePrivateNetworking: true
        enabled: true
        azureEnvironment: AZURE
        tenantId: ${azureTenantId}
        subscriptionId: ${azureSubscriptionId}
        clientId: ${azureClientId}
        secret: ${azureClientSecret}
        resourceGroupName: ${azureResourceGroupName}
        keyVaultName: ${azureKeyVaultName}
        keyIdentifier: ${azureKeyIdentifier}
  # Creates private endpoint
  endpoint:
    type: mongodbatlas:EncryptionAtRestPrivateEndpoint
    properties:
      projectId: ${ear.projectId}
      cloudProvider: AZURE
      regionName: ${azureRegionName}
  # Approves private endpoint connection from Azure Key Vault
  approval:
    type: azapi:updateResource
    properties:
      type: Microsoft.KeyVault/Vaults/PrivateEndpointConnections@2023-07-01
      name: ${endpoint.privateEndpointConnectionName}
      parentId: ${keyVaultResourceId}
      body:
        fn::toJSON:
          properties:
            privateLinkServiceConnectionState:
              description: Approved via Terraform
              status: Approved
variables:
  keyVaultResourceId: /subscriptions/${azureSubscriptionId}/resourceGroups/${azureResourceGroupName}/providers/Microsoft.KeyVault/vaults/${azureKeyVaultName}
Copy

Make sure to reference the complete example section for detailed steps and considerations.

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

const ear = new mongodbatlas.EncryptionAtRest("ear", {
    projectId: atlasProjectId,
    awsKmsConfig: {
        requirePrivateNetworking: true,
        enabled: true,
        customerMasterKeyId: awsKmsKeyId,
        region: atlasAwsRegion,
        roleId: authRole.roleId,
    },
});
// Creates private endpoint
const endpoint = new mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint", {
    projectId: ear.projectId,
    cloudProvider: "AWS",
    regionName: atlasAwsRegion,
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

ear = mongodbatlas.EncryptionAtRest("ear",
    project_id=atlas_project_id,
    aws_kms_config={
        "require_private_networking": True,
        "enabled": True,
        "customer_master_key_id": aws_kms_key_id,
        "region": atlas_aws_region,
        "role_id": auth_role["roleId"],
    })
# Creates private endpoint
endpoint = mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint",
    project_id=ear.project_id,
    cloud_provider="AWS",
    region_name=atlas_aws_region)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ear, err := mongodbatlas.NewEncryptionAtRest(ctx, "ear", &mongodbatlas.EncryptionAtRestArgs{
			ProjectId: pulumi.Any(atlasProjectId),
			AwsKmsConfig: &mongodbatlas.EncryptionAtRestAwsKmsConfigArgs{
				RequirePrivateNetworking: pulumi.Bool(true),
				Enabled:                  pulumi.Bool(true),
				CustomerMasterKeyId:      pulumi.Any(awsKmsKeyId),
				Region:                   pulumi.Any(atlasAwsRegion),
				RoleId:                   pulumi.Any(authRole.RoleId),
			},
		})
		if err != nil {
			return err
		}
		// Creates private endpoint
		_, err = mongodbatlas.NewEncryptionAtRestPrivateEndpoint(ctx, "endpoint", &mongodbatlas.EncryptionAtRestPrivateEndpointArgs{
			ProjectId:     ear.ProjectId,
			CloudProvider: pulumi.String("AWS"),
			RegionName:    pulumi.Any(atlasAwsRegion),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var ear = new Mongodbatlas.EncryptionAtRest("ear", new()
    {
        ProjectId = atlasProjectId,
        AwsKmsConfig = new Mongodbatlas.Inputs.EncryptionAtRestAwsKmsConfigArgs
        {
            RequirePrivateNetworking = true,
            Enabled = true,
            CustomerMasterKeyId = awsKmsKeyId,
            Region = atlasAwsRegion,
            RoleId = authRole.RoleId,
        },
    });

    // Creates private endpoint
    var endpoint = new Mongodbatlas.EncryptionAtRestPrivateEndpoint("endpoint", new()
    {
        ProjectId = ear.ProjectId,
        CloudProvider = "AWS",
        RegionName = atlasAwsRegion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.EncryptionAtRest;
import com.pulumi.mongodbatlas.EncryptionAtRestArgs;
import com.pulumi.mongodbatlas.inputs.EncryptionAtRestAwsKmsConfigArgs;
import com.pulumi.mongodbatlas.EncryptionAtRestPrivateEndpoint;
import com.pulumi.mongodbatlas.EncryptionAtRestPrivateEndpointArgs;
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 ear = new EncryptionAtRest("ear", EncryptionAtRestArgs.builder()
            .projectId(atlasProjectId)
            .awsKmsConfig(EncryptionAtRestAwsKmsConfigArgs.builder()
                .requirePrivateNetworking(true)
                .enabled(true)
                .customerMasterKeyId(awsKmsKeyId)
                .region(atlasAwsRegion)
                .roleId(authRole.roleId())
                .build())
            .build());

        // Creates private endpoint
        var endpoint = new EncryptionAtRestPrivateEndpoint("endpoint", EncryptionAtRestPrivateEndpointArgs.builder()
            .projectId(ear.projectId())
            .cloudProvider("AWS")
            .regionName(atlasAwsRegion)
            .build());

    }
}
Copy
resources:
  ear:
    type: mongodbatlas:EncryptionAtRest
    properties:
      projectId: ${atlasProjectId}
      awsKmsConfig:
        requirePrivateNetworking: true
        enabled: true
        customerMasterKeyId: ${awsKmsKeyId}
        region: ${atlasAwsRegion}
        roleId: ${authRole.roleId}
  # Creates private endpoint
  endpoint:
    type: mongodbatlas:EncryptionAtRestPrivateEndpoint
    properties:
      projectId: ${ear.projectId}
      cloudProvider: AWS
      regionName: ${atlasAwsRegion}
Copy

Create EncryptionAtRestPrivateEndpoint Resource

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

Constructor syntax

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

@overload
def EncryptionAtRestPrivateEndpoint(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    cloud_provider: Optional[str] = None,
                                    project_id: Optional[str] = None,
                                    region_name: Optional[str] = None)
func NewEncryptionAtRestPrivateEndpoint(ctx *Context, name string, args EncryptionAtRestPrivateEndpointArgs, opts ...ResourceOption) (*EncryptionAtRestPrivateEndpoint, error)
public EncryptionAtRestPrivateEndpoint(string name, EncryptionAtRestPrivateEndpointArgs args, CustomResourceOptions? opts = null)
public EncryptionAtRestPrivateEndpoint(String name, EncryptionAtRestPrivateEndpointArgs args)
public EncryptionAtRestPrivateEndpoint(String name, EncryptionAtRestPrivateEndpointArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EncryptionAtRestPrivateEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EncryptionAtRestPrivateEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EncryptionAtRestPrivateEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EncryptionAtRestPrivateEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EncryptionAtRestPrivateEndpointArgs
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 encryptionAtRestPrivateEndpointResource = new Mongodbatlas.EncryptionAtRestPrivateEndpoint("encryptionAtRestPrivateEndpointResource", new()
{
    CloudProvider = "string",
    ProjectId = "string",
    RegionName = "string",
});
Copy
example, err := mongodbatlas.NewEncryptionAtRestPrivateEndpoint(ctx, "encryptionAtRestPrivateEndpointResource", &mongodbatlas.EncryptionAtRestPrivateEndpointArgs{
	CloudProvider: pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	RegionName:    pulumi.String("string"),
})
Copy
var encryptionAtRestPrivateEndpointResource = new EncryptionAtRestPrivateEndpoint("encryptionAtRestPrivateEndpointResource", EncryptionAtRestPrivateEndpointArgs.builder()
    .cloudProvider("string")
    .projectId("string")
    .regionName("string")
    .build());
Copy
encryption_at_rest_private_endpoint_resource = mongodbatlas.EncryptionAtRestPrivateEndpoint("encryptionAtRestPrivateEndpointResource",
    cloud_provider="string",
    project_id="string",
    region_name="string")
Copy
const encryptionAtRestPrivateEndpointResource = new mongodbatlas.EncryptionAtRestPrivateEndpoint("encryptionAtRestPrivateEndpointResource", {
    cloudProvider: "string",
    projectId: "string",
    regionName: "string",
});
Copy
type: mongodbatlas:EncryptionAtRestPrivateEndpoint
properties:
    cloudProvider: string
    projectId: string
    regionName: string
Copy

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

CloudProvider This property is required. string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
RegionName This property is required. string
Cloud provider region in which the Encryption At Rest private endpoint is located.
CloudProvider This property is required. string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
RegionName This property is required. string
Cloud provider region in which the Encryption At Rest private endpoint is located.
cloudProvider This property is required. String
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.
regionName This property is required. String
Cloud provider region in which the Encryption At Rest private endpoint is located.
cloudProvider This property is required. string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
projectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
regionName This property is required. string
Cloud provider region in which the Encryption At Rest private endpoint is located.
cloud_provider This property is required. str
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
project_id This property is required. str
Unique 24-hexadecimal digit string that identifies your project.
region_name This property is required. str
Cloud provider region in which the Encryption At Rest private endpoint is located.
cloudProvider This property is required. String
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.
regionName This property is required. String
Cloud provider region in which the Encryption At Rest private endpoint is located.

Outputs

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

ErrorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
Status string
State of the Encryption At Rest private endpoint.
ErrorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
Status string
State of the Encryption At Rest private endpoint.
errorMessage String
Error message for failures associated with the Encryption At Rest private endpoint.
id String
The provider-assigned unique ID for this managed resource.
privateEndpointConnectionName String
Connection name of the Azure Private Endpoint.
status String
State of the Encryption At Rest private endpoint.
errorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
id string
The provider-assigned unique ID for this managed resource.
privateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
status string
State of the Encryption At Rest private endpoint.
error_message str
Error message for failures associated with the Encryption At Rest private endpoint.
id str
The provider-assigned unique ID for this managed resource.
private_endpoint_connection_name str
Connection name of the Azure Private Endpoint.
status str
State of the Encryption At Rest private endpoint.
errorMessage String
Error message for failures associated with the Encryption At Rest private endpoint.
id String
The provider-assigned unique ID for this managed resource.
privateEndpointConnectionName String
Connection name of the Azure Private Endpoint.
status String
State of the Encryption At Rest private endpoint.

Look up Existing EncryptionAtRestPrivateEndpoint Resource

Get an existing EncryptionAtRestPrivateEndpoint 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?: EncryptionAtRestPrivateEndpointState, opts?: CustomResourceOptions): EncryptionAtRestPrivateEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        error_message: Optional[str] = None,
        private_endpoint_connection_name: Optional[str] = None,
        project_id: Optional[str] = None,
        region_name: Optional[str] = None,
        status: Optional[str] = None) -> EncryptionAtRestPrivateEndpoint
func GetEncryptionAtRestPrivateEndpoint(ctx *Context, name string, id IDInput, state *EncryptionAtRestPrivateEndpointState, opts ...ResourceOption) (*EncryptionAtRestPrivateEndpoint, error)
public static EncryptionAtRestPrivateEndpoint Get(string name, Input<string> id, EncryptionAtRestPrivateEndpointState? state, CustomResourceOptions? opts = null)
public static EncryptionAtRestPrivateEndpoint get(String name, Output<String> id, EncryptionAtRestPrivateEndpointState state, CustomResourceOptions options)
resources:  _:    type: mongodbatlas:EncryptionAtRestPrivateEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CloudProvider string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
ErrorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
PrivateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
ProjectId string
Unique 24-hexadecimal digit string that identifies your project.
RegionName string
Cloud provider region in which the Encryption At Rest private endpoint is located.
Status string
State of the Encryption At Rest private endpoint.
CloudProvider string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
ErrorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
PrivateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
ProjectId string
Unique 24-hexadecimal digit string that identifies your project.
RegionName string
Cloud provider region in which the Encryption At Rest private endpoint is located.
Status string
State of the Encryption At Rest private endpoint.
cloudProvider String
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
errorMessage String
Error message for failures associated with the Encryption At Rest private endpoint.
privateEndpointConnectionName String
Connection name of the Azure Private Endpoint.
projectId String
Unique 24-hexadecimal digit string that identifies your project.
regionName String
Cloud provider region in which the Encryption At Rest private endpoint is located.
status String
State of the Encryption At Rest private endpoint.
cloudProvider string
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
errorMessage string
Error message for failures associated with the Encryption At Rest private endpoint.
privateEndpointConnectionName string
Connection name of the Azure Private Endpoint.
projectId string
Unique 24-hexadecimal digit string that identifies your project.
regionName string
Cloud provider region in which the Encryption At Rest private endpoint is located.
status string
State of the Encryption At Rest private endpoint.
cloud_provider str
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
error_message str
Error message for failures associated with the Encryption At Rest private endpoint.
private_endpoint_connection_name str
Connection name of the Azure Private Endpoint.
project_id str
Unique 24-hexadecimal digit string that identifies your project.
region_name str
Cloud provider region in which the Encryption At Rest private endpoint is located.
status str
State of the Encryption At Rest private endpoint.
cloudProvider String
Label that identifies the cloud provider for the Encryption At Rest private endpoint.
errorMessage String
Error message for failures associated with the Encryption At Rest private endpoint.
privateEndpointConnectionName String
Connection name of the Azure Private Endpoint.
projectId String
Unique 24-hexadecimal digit string that identifies your project.
regionName String
Cloud provider region in which the Encryption At Rest private endpoint is located.
status String
State of the Encryption At Rest private endpoint.

Import

Encryption At Rest Private Endpoint resource can be imported using the project ID, cloud provider, and private endpoint ID. The format must be {project_id}-{cloud_provider}-{private_endpoint_id} e.g.

$ terraform import mongodbatlas_encryption_at_rest_private_endpoint.test 650972848269185c55f40ca1-AZURE-650972848269185c55f40ca2
$ terraform import mongodbatlas_encryption_at_rest_private_endpoint.test 650972848269185c55f40ca2-AWS-650972848269185c55f40ca3

For more information see:

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

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas