Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. LdapVerify
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.LdapVerify

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    # Resource: mongodbatlas.LdapVerify

    mongodbatlas.LdapVerify provides an LDAP Verify resource. This allows a a verification of an LDAP configuration over TLS for an Atlas project. Atlas retains only the most recent request for each project.

    Example Usage

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

const test = new mongodbatlas.Project("test", {
    name: "NAME OF THE PROJECT",
    orgId: "ORG ID",
});
const testAdvancedCluster = new mongodbatlas.AdvancedCluster("test", {
    projectId: test.id,
    name: "NAME OF THE CLUSTER",
    clusterType: "REPLICASET",
    backupEnabled: true,
    replicationSpecs: [{
        regionConfigs: [{
            priority: 7,
            providerName: "AWS",
            regionName: "US_EAST_1",
            electableSpecs: {
                instanceSize: "M10",
                nodeCount: 3,
            },
        }],
    }],
});
const testLdapVerify = new mongodbatlas.LdapVerify("test", {
    projectId: test.id,
    hostname: "HOSTNAME",
    port: 636,
    bindUsername: "USERNAME",
    bindPassword: "PASSWORD",
}, {
    dependsOn: [testAdvancedCluster],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Project("test",
    name="NAME OF THE PROJECT",
    org_id="ORG ID")
test_advanced_cluster = mongodbatlas.AdvancedCluster("test",
    project_id=test.id,
    name="NAME OF THE CLUSTER",
    cluster_type="REPLICASET",
    backup_enabled=True,
    replication_specs=[{
        "region_configs": [{
            "priority": 7,
            "provider_name": "AWS",
            "region_name": "US_EAST_1",
            "electable_specs": {
                "instance_size": "M10",
                "node_count": 3,
            },
        }],
    }])
test_ldap_verify = mongodbatlas.LdapVerify("test",
    project_id=test.id,
    hostname="HOSTNAME",
    port=636,
    bind_username="USERNAME",
    bind_password="PASSWORD",
    opts = pulumi.ResourceOptions(depends_on=[test_advanced_cluster]))

    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 {
		test, err := mongodbatlas.NewProject(ctx, "test", &mongodbatlas.ProjectArgs{
			Name:  pulumi.String("NAME OF THE PROJECT"),
			OrgId: pulumi.String("ORG ID"),
		})
		if err != nil {
			return err
		}
		testAdvancedCluster, err := mongodbatlas.NewAdvancedCluster(ctx, "test", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:     test.ID(),
			Name:          pulumi.String("NAME OF THE CLUSTER"),
			ClusterType:   pulumi.String("REPLICASET"),
			BackupEnabled: pulumi.Bool(true),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							Priority:     pulumi.Int(7),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("US_EAST_1"),
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewLdapVerify(ctx, "test", &mongodbatlas.LdapVerifyArgs{
			ProjectId:    test.ID(),
			Hostname:     pulumi.String("HOSTNAME"),
			Port:         pulumi.Int(636),
			BindUsername: pulumi.String("USERNAME"),
			BindPassword: pulumi.String("PASSWORD"),
		}, pulumi.DependsOn([]pulumi.Resource{
			testAdvancedCluster,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.Project("test", new()
    {
        Name = "NAME OF THE PROJECT",
        OrgId = "ORG ID",
    });

    var testAdvancedCluster = new Mongodbatlas.AdvancedCluster("test", new()
    {
        ProjectId = test.Id,
        Name = "NAME OF THE CLUSTER",
        ClusterType = "REPLICASET",
        BackupEnabled = true,
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        Priority = 7,
                        ProviderName = "AWS",
                        RegionName = "US_EAST_1",
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                    },
                },
            },
        },
    });

    var testLdapVerify = new Mongodbatlas.LdapVerify("test", new()
    {
        ProjectId = test.Id,
        Hostname = "HOSTNAME",
        Port = 636,
        BindUsername = "USERNAME",
        BindPassword = "PASSWORD",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            testAdvancedCluster,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Project;
import com.pulumi.mongodbatlas.ProjectArgs;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.LdapVerify;
import com.pulumi.mongodbatlas.LdapVerifyArgs;
import com.pulumi.resources.CustomResourceOptions;
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 test = new Project("test", ProjectArgs.builder()
            .name("NAME OF THE PROJECT")
            .orgId("ORG ID")
            .build());

        var testAdvancedCluster = new AdvancedCluster("testAdvancedCluster", AdvancedClusterArgs.builder()
            .projectId(test.id())
            .name("NAME OF THE CLUSTER")
            .clusterType("REPLICASET")
            .backupEnabled(true)
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .priority(7)
                    .providerName("AWS")
                    .regionName("US_EAST_1")
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(3)
                        .build())
                    .build())
                .build())
            .build());

        var testLdapVerify = new LdapVerify("testLdapVerify", LdapVerifyArgs.builder()
            .projectId(test.id())
            .hostname("HOSTNAME")
            .port(636)
            .bindUsername("USERNAME")
            .bindPassword("PASSWORD")
            .build(), CustomResourceOptions.builder()
                .dependsOn(testAdvancedCluster)
                .build());

    }
}

    resources:
  test:
    type: mongodbatlas:Project
    properties:
      name: NAME OF THE PROJECT
      orgId: ORG ID
  testAdvancedCluster:
    type: mongodbatlas:AdvancedCluster
    name: test
    properties:
      projectId: ${test.id}
      name: NAME OF THE CLUSTER
      clusterType: REPLICASET
      backupEnabled: true # enable cloud backup snapshots
      replicationSpecs:
        - regionConfigs:
            - priority: 7
              providerName: AWS
              regionName: US_EAST_1
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
  testLdapVerify:
    type: mongodbatlas:LdapVerify
    name: test
    properties:
      projectId: ${test.id}
      hostname: HOSTNAME
      port: 636
      bindUsername: USERNAME
      bindPassword: PASSWORD
    options:
      dependson:
        - ${testAdvancedCluster}

    Create LdapVerify Resource

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

    Constructor syntax

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

@overload
def LdapVerify(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bind_password: Optional[str] = None,
               bind_username: Optional[str] = None,
               hostname: Optional[str] = None,
               port: Optional[int] = None,
               project_id: Optional[str] = None,
               authz_query_template: Optional[str] = None,
               ca_certificate: Optional[str] = None)
    func NewLdapVerify(ctx *Context, name string, args LdapVerifyArgs, opts ...ResourceOption) (*LdapVerify, error)
    public LdapVerify(string name, LdapVerifyArgs args, CustomResourceOptions? opts = null)
    public LdapVerify(String name, LdapVerifyArgs args)
public LdapVerify(String name, LdapVerifyArgs args, CustomResourceOptions options)

    type: mongodbatlas:LdapVerify
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 LdapVerifyArgs
    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 LdapVerifyArgs
    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 LdapVerifyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LdapVerifyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LdapVerifyArgs
    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 ldapVerifyResource = new Mongodbatlas.LdapVerify("ldapVerifyResource", new()
{
    BindPassword = "string",
    BindUsername = "string",
    Hostname = "string",
    Port = 0,
    ProjectId = "string",
    AuthzQueryTemplate = "string",
    CaCertificate = "string",
});

    example, err := mongodbatlas.NewLdapVerify(ctx, "ldapVerifyResource", &mongodbatlas.LdapVerifyArgs{
	BindPassword:       pulumi.String("string"),
	BindUsername:       pulumi.String("string"),
	Hostname:           pulumi.String("string"),
	Port:               pulumi.Int(0),
	ProjectId:          pulumi.String("string"),
	AuthzQueryTemplate: pulumi.String("string"),
	CaCertificate:      pulumi.String("string"),
})

    var ldapVerifyResource = new LdapVerify("ldapVerifyResource", LdapVerifyArgs.builder()
    .bindPassword("string")
    .bindUsername("string")
    .hostname("string")
    .port(0)
    .projectId("string")
    .authzQueryTemplate("string")
    .caCertificate("string")
    .build());

    ldap_verify_resource = mongodbatlas.LdapVerify("ldapVerifyResource",
    bind_password="string",
    bind_username="string",
    hostname="string",
    port=0,
    project_id="string",
    authz_query_template="string",
    ca_certificate="string")

    const ldapVerifyResource = new mongodbatlas.LdapVerify("ldapVerifyResource", {
    bindPassword: "string",
    bindUsername: "string",
    hostname: "string",
    port: 0,
    projectId: "string",
    authzQueryTemplate: "string",
    caCertificate: "string",
});

    type: mongodbatlas:LdapVerify
properties:
    authzQueryTemplate: string
    bindPassword: string
    bindUsername: string
    caCertificate: string
    hostname: string
    port: 0
    projectId: string

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

    BindPassword string
    The password used to authenticate the bind_username.
    BindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    Hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    Port int
    The port to which the LDAP server listens for client connections. Default: 636
    ProjectId string
    The unique ID for the project to configure LDAP.
    AuthzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    CaCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    BindPassword string
    The password used to authenticate the bind_username.
    BindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    Hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    Port int
    The port to which the LDAP server listens for client connections. Default: 636
    ProjectId string
    The unique ID for the project to configure LDAP.
    AuthzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    CaCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    bindPassword String
    The password used to authenticate the bind_username.
    bindUsername String
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    hostname String
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    port Integer
    The port to which the LDAP server listens for client connections. Default: 636
    projectId String
    The unique ID for the project to configure LDAP.
    authzQueryTemplate String
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    caCertificate String
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    bindPassword string
    The password used to authenticate the bind_username.
    bindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    port number
    The port to which the LDAP server listens for client connections. Default: 636
    projectId string
    The unique ID for the project to configure LDAP.
    authzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    caCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    bind_password str
    The password used to authenticate the bind_username.
    bind_username str
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    hostname str
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    port int
    The port to which the LDAP server listens for client connections. Default: 636
    project_id str
    The unique ID for the project to configure LDAP.
    authz_query_template str
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    ca_certificate str
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    bindPassword String
    The password used to authenticate the bind_username.
    bindUsername String
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    hostname String
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    port Number
    The port to which the LDAP server listens for client connections. Default: 636
    projectId String
    The unique ID for the project to configure LDAP.
    authzQueryTemplate String
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    caCertificate String
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<LdapVerifyLink>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    RequestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    Validations List<LdapVerifyValidation>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []LdapVerifyLink
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    RequestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    Validations []LdapVerifyValidation
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    id String
    The provider-assigned unique ID for this managed resource.
    links List<LdapVerifyLink>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    requestId String
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations List<LdapVerifyValidation>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    id string
    The provider-assigned unique ID for this managed resource.
    links LdapVerifyLink[]
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    requestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations LdapVerifyValidation[]
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[LdapVerifyLink]
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    request_id str
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status str
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations Sequence[LdapVerifyValidation]
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    requestId String
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations List<Property Map>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

    Look up Existing LdapVerify Resource

    Get an existing LdapVerify 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?: LdapVerifyState, opts?: CustomResourceOptions): LdapVerify
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authz_query_template: Optional[str] = None,
        bind_password: Optional[str] = None,
        bind_username: Optional[str] = None,
        ca_certificate: Optional[str] = None,
        hostname: Optional[str] = None,
        links: Optional[Sequence[LdapVerifyLinkArgs]] = None,
        port: Optional[int] = None,
        project_id: Optional[str] = None,
        request_id: Optional[str] = None,
        status: Optional[str] = None,
        validations: Optional[Sequence[LdapVerifyValidationArgs]] = None) -> LdapVerify
    func GetLdapVerify(ctx *Context, name string, id IDInput, state *LdapVerifyState, opts ...ResourceOption) (*LdapVerify, error)
    public static LdapVerify Get(string name, Input<string> id, LdapVerifyState? state, CustomResourceOptions? opts = null)
    public static LdapVerify get(String name, Output<String> id, LdapVerifyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AuthzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    BindPassword string
    The password used to authenticate the bind_username.
    BindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    CaCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    Hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    Links List<LdapVerifyLink>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    Port int
    The port to which the LDAP server listens for client connections. Default: 636
    ProjectId string
    The unique ID for the project to configure LDAP.
    RequestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    Validations List<LdapVerifyValidation>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    AuthzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    BindPassword string
    The password used to authenticate the bind_username.
    BindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    CaCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    Hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    Links []LdapVerifyLinkArgs
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    Port int
    The port to which the LDAP server listens for client connections. Default: 636
    ProjectId string
    The unique ID for the project to configure LDAP.
    RequestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    Validations []LdapVerifyValidationArgs
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    authzQueryTemplate String
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    bindPassword String
    The password used to authenticate the bind_username.
    bindUsername String
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    caCertificate String
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    hostname String
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    links List<LdapVerifyLink>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    port Integer
    The port to which the LDAP server listens for client connections. Default: 636
    projectId String
    The unique ID for the project to configure LDAP.
    requestId String
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations List<LdapVerifyValidation>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    authzQueryTemplate string
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    bindPassword string
    The password used to authenticate the bind_username.
    bindUsername string
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    caCertificate string
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    hostname string
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    links LdapVerifyLink[]
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    port number
    The port to which the LDAP server listens for client connections. Default: 636
    projectId string
    The unique ID for the project to configure LDAP.
    requestId string
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations LdapVerifyValidation[]
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    authz_query_template str
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    bind_password str
    The password used to authenticate the bind_username.
    bind_username str
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    ca_certificate str
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    hostname str
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    links Sequence[LdapVerifyLinkArgs]
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    port int
    The port to which the LDAP server listens for client connections. Default: 636
    project_id str
    The unique ID for the project to configure LDAP.
    request_id str
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status str
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations Sequence[LdapVerifyValidationArgs]
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values
    authzQueryTemplate String
    An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.
    bindPassword String
    The password used to authenticate the bind_username.
    bindUsername String
    The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.
    caCertificate String
    CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.
    hostname String
    The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.
    links List<Property Map>
    One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.
    port Number
    The port to which the LDAP server listens for client connections. Default: 636
    projectId String
    The unique ID for the project to configure LDAP.
    requestId String
    The unique identifier for the request to verify the LDAP over TLS/SSL configuration.
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validations List<Property Map>
    Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

    Supporting Types

    Href string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    LdapVerifyValidation, LdapVerifyValidationArgs

    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    ValidationType string
    Status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    ValidationType string
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validationType String
    status string
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validationType string
    status str
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validation_type str
    status String
    The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.
    validationType String

    Import

    LDAP Configuration must be imported using project ID and request ID, e.g.

    $ pulumi import mongodbatlas:index/ldapVerify:LdapVerify test 5d09d6a59ccf6445652a444a-5d09d6a59ccf6445652a444a

    For more information see: MongoDB Atlas API Reference.

    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.
    mongodbatlas logo
    MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas