MongoDB Atlas v3.18.0, Sep 12 24

MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

mongodbatlas.getEncryptionAtRestPrivateEndpoints

Explore with Pulumi AI

MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

# Data Source: mongodbatlas.getEncryptionAtRestPrivateEndpoints

mongodbatlas.getEncryptionAtRestPrivateEndpoints describes private endpoints of a particular cloud provider used for encryption at rest using customer-managed keys.

IMPORTANT The Encryption at Rest using Azure Key Vault over Private Endpoints feature is available by request. To request this functionality for your Atlas deployments, contact your Account Manager. To learn more about existing limitations, see Manage Customer Keys with Azure Key Vault Over Private Endpoints.

Example Usage

S

NOTE: Only Azure Key Vault with Azure Private Link is supported at this time.

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

const plural = mongodbatlas.getEncryptionAtRestPrivateEndpoints({
    projectId: atlasProjectId,
    cloudProvider: "AZURE",
});
export const numberOfEndpoints = plural.then(plural => plural.results).length;

import pulumi
import pulumi_mongodbatlas as mongodbatlas

plural = mongodbatlas.get_encryption_at_rest_private_endpoints(project_id=atlas_project_id,
    cloud_provider="AZURE")
pulumi.export("numberOfEndpoints", len(plural.results))

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 {
		plural, err := mongodbatlas.LookupEncryptionAtRestPrivateEndpoints(ctx, &mongodbatlas.LookupEncryptionAtRestPrivateEndpointsArgs{
			ProjectId:     atlasProjectId,
			CloudProvider: "AZURE",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("numberOfEndpoints", pulumi.Int(len(plural.Results)))
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var plural = Mongodbatlas.GetEncryptionAtRestPrivateEndpoints.Invoke(new()
    {
        ProjectId = atlasProjectId,
        CloudProvider = "AZURE",
    });

    return new Dictionary<string, object?>
    {
        ["numberOfEndpoints"] = plural.Apply(getEncryptionAtRestPrivateEndpointsResult => getEncryptionAtRestPrivateEndpointsResult.Results).Length,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetEncryptionAtRestPrivateEndpointsArgs;
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) {
        final var plural = MongodbatlasFunctions.getEncryptionAtRestPrivateEndpoints(GetEncryptionAtRestPrivateEndpointsArgs.builder()
            .projectId(atlasProjectId)
            .cloudProvider("AZURE")
            .build());

        ctx.export("numberOfEndpoints", plural.applyValue(getEncryptionAtRestPrivateEndpointsResult -> getEncryptionAtRestPrivateEndpointsResult.results()).length());
    }
}

Coming soon!

Using getEncryptionAtRestPrivateEndpoints

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEncryptionAtRestPrivateEndpoints(args: GetEncryptionAtRestPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetEncryptionAtRestPrivateEndpointsResult>
function getEncryptionAtRestPrivateEndpointsOutput(args: GetEncryptionAtRestPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEncryptionAtRestPrivateEndpointsResult>

def get_encryption_at_rest_private_endpoints(cloud_provider: Optional[str] = None,
                                             project_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetEncryptionAtRestPrivateEndpointsResult
def get_encryption_at_rest_private_endpoints_output(cloud_provider: Optional[pulumi.Input[str]] = None,
                                             project_id: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetEncryptionAtRestPrivateEndpointsResult]

func LookupEncryptionAtRestPrivateEndpoints(ctx *Context, args *LookupEncryptionAtRestPrivateEndpointsArgs, opts ...InvokeOption) (*LookupEncryptionAtRestPrivateEndpointsResult, error)
func LookupEncryptionAtRestPrivateEndpointsOutput(ctx *Context, args *LookupEncryptionAtRestPrivateEndpointsOutputArgs, opts ...InvokeOption) LookupEncryptionAtRestPrivateEndpointsResultOutput

> Note: This function is named LookupEncryptionAtRestPrivateEndpoints in the Go SDK.

public static class GetEncryptionAtRestPrivateEndpoints 
{
    public static Task<GetEncryptionAtRestPrivateEndpointsResult> InvokeAsync(GetEncryptionAtRestPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEncryptionAtRestPrivateEndpointsResult> Invoke(GetEncryptionAtRestPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEncryptionAtRestPrivateEndpointsResult> getEncryptionAtRestPrivateEndpoints(GetEncryptionAtRestPrivateEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getEncryptionAtRestPrivateEndpoints:getEncryptionAtRestPrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

CloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

cloudProvider String: Human-readable label that identifies the cloud provider for the private endpoints to return.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

cloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
projectId string: Unique 24-hexadecimal digit string that identifies your project.

cloud_provider str: Human-readable label that identifies the cloud provider for the private endpoints to return.
project_id str: Unique 24-hexadecimal digit string that identifies your project.

cloudProvider String: Human-readable label that identifies the cloud provider for the private endpoints to return.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

getEncryptionAtRestPrivateEndpoints Result

The following output properties are available:

CloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.
Results List<GetEncryptionAtRestPrivateEndpointsResult>: List of returned documents that MongoDB Cloud providers when completing this request.

CloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.
Results []GetEncryptionAtRestPrivateEndpointsResult: List of returned documents that MongoDB Cloud providers when completing this request.

cloudProvider String: Human-readable label that identifies the cloud provider for the private endpoints to return.
id String: The provider-assigned unique ID for this managed resource.
projectId String: Unique 24-hexadecimal digit string that identifies your project.
results List<GetEncryptionAtRestPrivateEndpointsResult>: List of returned documents that MongoDB Cloud providers when completing this request.

cloudProvider string: Human-readable label that identifies the cloud provider for the private endpoints to return.
id string: The provider-assigned unique ID for this managed resource.
projectId string: Unique 24-hexadecimal digit string that identifies your project.
results GetEncryptionAtRestPrivateEndpointsResult[]: List of returned documents that MongoDB Cloud providers when completing this request.

cloud_provider str: Human-readable label that identifies the cloud provider for the private endpoints to return.
id str: The provider-assigned unique ID for this managed resource.
project_id str: Unique 24-hexadecimal digit string that identifies your project.
results Sequence[GetEncryptionAtRestPrivateEndpointsResult]: List of returned documents that MongoDB Cloud providers when completing this request.

cloudProvider String: Human-readable label that identifies the cloud provider for the private endpoints to return.
id String: The provider-assigned unique ID for this managed resource.
projectId String: Unique 24-hexadecimal digit string that identifies your project.
results List<Property Map>: List of returned documents that MongoDB Cloud providers when completing this request.

Supporting Types

GetEncryptionAtRestPrivateEndpointsResult

CloudProvider string: Label that identifies the cloud provider of the private endpoint.
ErrorMessage string: Error message for failures associated with the Encryption At Rest private endpoint.
Id string: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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 of the private endpoint.
ErrorMessage string: Error message for failures associated with the Encryption At Rest private endpoint.
Id string: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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 of the private endpoint.
errorMessage String: Error message for failures associated with the Encryption At Rest private endpoint.
id String: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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 of the private endpoint.
errorMessage string: Error message for failures associated with the Encryption At Rest private endpoint.
id string: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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 of the private endpoint.
error_message str: Error message for failures associated with the Encryption At Rest private endpoint.
id str: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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 of the private endpoint.
errorMessage String: Error message for failures associated with the Encryption At Rest private endpoint.
id String: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
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.

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.18.0 published on Thursday, Sep 12, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getEncryptionAtRestPrivateEndpoints

On this page

On this page

# Data Source: mongodbatlas.getEncryptionAtRestPrivateEndpoints

Example Usage

S

Using getEncryptionAtRestPrivateEndpoints

getEncryptionAtRestPrivateEndpoints Result

Supporting Types

GetEncryptionAtRestPrivateEndpointsResult

Package Details

On this page

On this page