MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi
mongodbatlas.getPrivatelinkEndpointServiceDataFederationOnlineArchive
Explore with Pulumi AI
# Data Source: mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive
mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive
describes a Private Endpoint Service resource for Data Federation and Online Archive.
NOTE: Groups and projects are synonymous terms. You may find
groupId
in the official documentation.
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",
});
const testDataSource = mongodbatlas.getPrivatelinkEndpointServiceDataFederationOnlineArchiveOutput({
projectId: atlas_project.id,
endpointId: test.endpointId,
});
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")
test_data_source = mongodbatlas.get_privatelink_endpoint_service_data_federation_online_archive_output(project_id=atlas_project.id,
endpoint_id=test.endpoint_id)
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
}
test, 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
}
_ = mongodbatlas.LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveOutput(ctx, mongodbatlas.GetPrivatelinkEndpointServiceDataFederationOnlineArchiveOutputArgs{
ProjectId: atlas_project.ID(),
EndpointId: test.EndpointId,
}, nil)
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",
});
var testDataSource = Mongodbatlas.GetPrivatelinkEndpointServiceDataFederationOnlineArchive.Invoke(new()
{
ProjectId = atlas_project.Id,
EndpointId = test.EndpointId,
});
});
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 com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs;
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());
final var testDataSource = MongodbatlasFunctions.getPrivatelinkEndpointServiceDataFederationOnlineArchive(GetPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs.builder()
.projectId(atlas_project.id())
.endpointId(test.endpointId())
.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
variables:
testDataSource:
fn::invoke:
Function: mongodbatlas:getPrivatelinkEndpointServiceDataFederationOnlineArchive
Arguments:
projectId: ${["atlas-project"].id}
endpointId: ${test.endpointId}
Using getPrivatelinkEndpointServiceDataFederationOnlineArchive
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 getPrivatelinkEndpointServiceDataFederationOnlineArchive(args: GetPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs, opts?: InvokeOptions): Promise<GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult>
function getPrivatelinkEndpointServiceDataFederationOnlineArchiveOutput(args: GetPrivatelinkEndpointServiceDataFederationOnlineArchiveOutputArgs, opts?: InvokeOptions): Output<GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult>
def get_privatelink_endpoint_service_data_federation_online_archive(endpoint_id: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult
def get_privatelink_endpoint_service_data_federation_online_archive_output(endpoint_id: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult]
func LookupPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx *Context, args *LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs, opts ...InvokeOption) (*LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveResult, error)
func LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveOutput(ctx *Context, args *LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveOutputArgs, opts ...InvokeOption) LookupPrivatelinkEndpointServiceDataFederationOnlineArchiveResultOutput
> Note: This function is named LookupPrivatelinkEndpointServiceDataFederationOnlineArchive
in the Go SDK.
public static class GetPrivatelinkEndpointServiceDataFederationOnlineArchive
{
public static Task<GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult> InvokeAsync(GetPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, InvokeOptions? opts = null)
public static Output<GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult> Invoke(GetPrivatelinkEndpointServiceDataFederationOnlineArchiveInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivatelinkEndpointServiceDataFederationOnlineArchiveResult> getPrivatelinkEndpointServiceDataFederationOnlineArchive(GetPrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getPrivatelinkEndpointServiceDataFederationOnlineArchive:getPrivatelinkEndpointServiceDataFederationOnlineArchive
arguments:
# arguments dictionary
The following arguments are supported:
- Endpoint
Id 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.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Endpoint
Id 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.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- endpoint
Id 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.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- endpoint
Id 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.
- project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- 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.
- endpoint
Id 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.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
getPrivatelinkEndpointServiceDataFederationOnlineArchive Result
The following output properties are available:
- Comment string
- Human-readable string to associate with this private endpoint.
- Customer
Endpoint stringDns Name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- Endpoint
Id string - Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Provider
Name 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.
- Customer
Endpoint stringDns Name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- Endpoint
Id string - Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Provider
Name 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.
- customer
Endpoint StringDns Name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- endpoint
Id String - id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - provider
Name 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.
- customer
Endpoint stringDns Name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- endpoint
Id string - id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - provider
Name 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_ strdns_ name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- endpoint_
id str - id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - 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.
- customer
Endpoint StringDns Name - (Optional) Human-readable label to identify VPC endpoint DNS name.
- endpoint
Id String - id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - provider
Name 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.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.