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

mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive

Explore with Pulumi AI

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

    # Resource: mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive

    mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive provides a Private Endpoint Service resource for Data Federation and Online Archive. The resource allows you to create and manage a private endpoint for Federated Database Instances and Online Archives to the specified project.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    NOTE: Updates are limited to the comment argument.

    Example Usage

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

const atlas_project = new mongodbatlas.Project("atlas-project", {
    orgId: atlasOrgId,
    name: atlasProjectName,
});
const test = new mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("test", {
    projectId: atlas_project.id,
    endpointId: "vpce-046cf43c79424d4c9",
    providerName: "AWS",
    comment: "Test",
    region: "US_EAST_1",
    customerEndpointDnsName: "vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

atlas_project = mongodbatlas.Project("atlas-project",
    org_id=atlas_org_id,
    name=atlas_project_name)
test = mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("test",
    project_id=atlas_project.id,
    endpoint_id="vpce-046cf43c79424d4c9",
    provider_name="AWS",
    comment="Test",
    region="US_EAST_1",
    customer_endpoint_dns_name="vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com")

    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 {
		_, err := mongodbatlas.NewProject(ctx, "atlas-project", &mongodbatlas.ProjectArgs{
			OrgId: pulumi.Any(atlasOrgId),
			Name:  pulumi.Any(atlasProjectName),
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx, "test", &mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs{
			ProjectId:               atlas_project.ID(),
			EndpointId:              pulumi.String("vpce-046cf43c79424d4c9"),
			ProviderName:            pulumi.String("AWS"),
			Comment:                 pulumi.String("Test"),
			Region:                  pulumi.String("US_EAST_1"),
			CustomerEndpointDnsName: pulumi.String("vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com"),
		})
		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 atlas_project = new Mongodbatlas.Project("atlas-project", new()
    {
        OrgId = atlasOrgId,
        Name = atlasProjectName,
    });

    var test = new Mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("test", new()
    {
        ProjectId = atlas_project.Id,
        EndpointId = "vpce-046cf43c79424d4c9",
        ProviderName = "AWS",
        Comment = "Test",
        Region = "US_EAST_1",
        CustomerEndpointDnsName = "vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com",
    });

});

    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.PrivatelinkEndpointServiceDataFederationOnlineArchive;
import com.pulumi.mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs;
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 atlas_project = new Project("atlas-project", ProjectArgs.builder()
            .orgId(atlasOrgId)
            .name(atlasProjectName)
            .build());

        var test = new PrivatelinkEndpointServiceDataFederationOnlineArchive("test", PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs.builder()
            .projectId(atlas_project.id())
            .endpointId("vpce-046cf43c79424d4c9")
            .providerName("AWS")
            .comment("Test")
            .region("US_EAST_1")
            .customerEndpointDnsName("vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com")
            .build());

    }
}

    resources:
  atlas-project:
    type: mongodbatlas:Project
    properties:
      orgId: ${atlasOrgId}
      name: ${atlasProjectName}
  test:
    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive
    properties:
      projectId: ${["atlas-project"].id}
      endpointId: vpce-046cf43c79424d4c9
      providerName: AWS
      comment: Test
      region: US_EAST_1
      customerEndpointDnsName: vpce-046cf43c79424d4c9-nmls2y9k.vpce-svc-0824460b72e1a420e.us-east-1.vpce.amazonaws.com

    Create PrivatelinkEndpointServiceDataFederationOnlineArchive Resource

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

    Constructor syntax

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

@overload
def PrivatelinkEndpointServiceDataFederationOnlineArchive(resource_name: str,
                                                          opts: Optional[ResourceOptions] = None,
                                                          endpoint_id: Optional[str] = None,
                                                          project_id: Optional[str] = None,
                                                          provider_name: Optional[str] = None,
                                                          comment: Optional[str] = None,
                                                          customer_endpoint_dns_name: Optional[str] = None,
                                                          region: Optional[str] = None)
    func NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx *Context, name string, args PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs, opts ...ResourceOption) (*PrivatelinkEndpointServiceDataFederationOnlineArchive, error)
    public PrivatelinkEndpointServiceDataFederationOnlineArchive(string name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, CustomResourceOptions? opts = null)
    public PrivatelinkEndpointServiceDataFederationOnlineArchive(String name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args)
public PrivatelinkEndpointServiceDataFederationOnlineArchive(String name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, CustomResourceOptions options)

    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive
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 PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs
    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 PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs
    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 PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs
    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 privatelinkEndpointServiceDataFederationOnlineArchiveResource = new Mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", new()
{
    EndpointId = "string",
    ProjectId = "string",
    ProviderName = "string",
    Comment = "string",
    CustomerEndpointDnsName = "string",
    Region = "string",
});

    example, err := mongodbatlas.NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx, "privatelinkEndpointServiceDataFederationOnlineArchiveResource", &mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs{
	EndpointId:              pulumi.String("string"),
	ProjectId:               pulumi.String("string"),
	ProviderName:            pulumi.String("string"),
	Comment:                 pulumi.String("string"),
	CustomerEndpointDnsName: pulumi.String("string"),
	Region:                  pulumi.String("string"),
})

    var privatelinkEndpointServiceDataFederationOnlineArchiveResource = new PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs.builder()
    .endpointId("string")
    .projectId("string")
    .providerName("string")
    .comment("string")
    .customerEndpointDnsName("string")
    .region("string")
    .build());

    privatelink_endpoint_service_data_federation_online_archive_resource = mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource",
    endpoint_id="string",
    project_id="string",
    provider_name="string",
    comment="string",
    customer_endpoint_dns_name="string",
    region="string")

    const privatelinkEndpointServiceDataFederationOnlineArchiveResource = new mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", {
    endpointId: "string",
    projectId: "string",
    providerName: "string",
    comment: "string",
    customerEndpointDnsName: "string",
    region: "string",
});

    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive
properties:
    comment: string
    customerEndpointDnsName: string
    endpointId: string
    projectId: string
    providerName: string
    region: string

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

    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    providerName String
    Human-readable label that identifies the cloud service provider.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    endpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    providerName string
    Human-readable label that identifies the cloud service provider.
    comment string
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    endpoint_id str
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    provider_name str
    Human-readable label that identifies the cloud service provider.
    comment str
    Human-readable string to associate with this private endpoint.
    customer_endpoint_dns_name str
    Human-readable label to identify VPC endpoint DNS name.
    region str
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    providerName String
    Human-readable label that identifies the cloud service provider.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Human-readable label that identifies the resource type associated with this private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.

    Look up Existing PrivatelinkEndpointServiceDataFederationOnlineArchive Resource

    Get an existing PrivatelinkEndpointServiceDataFederationOnlineArchive 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?: PrivatelinkEndpointServiceDataFederationOnlineArchiveState, opts?: CustomResourceOptions): PrivatelinkEndpointServiceDataFederationOnlineArchive
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        customer_endpoint_dns_name: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        type: Optional[str] = None) -> PrivatelinkEndpointServiceDataFederationOnlineArchive
    func GetPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx *Context, name string, id IDInput, state *PrivatelinkEndpointServiceDataFederationOnlineArchiveState, opts ...ResourceOption) (*PrivatelinkEndpointServiceDataFederationOnlineArchive, error)
    public static PrivatelinkEndpointServiceDataFederationOnlineArchive Get(string name, Input<string> id, PrivatelinkEndpointServiceDataFederationOnlineArchiveState? state, CustomResourceOptions? opts = null)
    public static PrivatelinkEndpointServiceDataFederationOnlineArchive get(String name, Output<String> id, PrivatelinkEndpointServiceDataFederationOnlineArchiveState 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:
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    providerName String
    Human-readable label that identifies the cloud service provider.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment string
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name.
    endpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    providerName string
    Human-readable label that identifies the cloud service provider.
    region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment str
    Human-readable string to associate with this private endpoint.
    customer_endpoint_dns_name str
    Human-readable label to identify VPC endpoint DNS name.
    endpoint_id str
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    provider_name str
    Human-readable label that identifies the cloud service provider.
    region str
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    type str
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    providerName String
    Human-readable label that identifies the cloud service provider.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.

    Import

    Private Endpoint Service resource for Data Federation and Online Archive can be imported using project ID, endpoint ID, in the format project_id–endpoint_id, e.g.

    $ pulumi import mongodbatlas:index/privatelinkEndpointServiceDataFederationOnlineArchive:PrivatelinkEndpointServiceDataFederationOnlineArchive example 1112222b3bf99403840e8934--vpce-3bf78b0ddee411ba1

    See MongoDB Atlas API Documentation for more information.

    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