MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.PrivateLinkEndpoint

Explore with Pulumi AI

Import

Private Endpoint Service can be imported using project ID, private link ID, provider name and region, in the format {project_id}-{private_link_id}-{provider_name}-{region}, e.g.

 $ pulumi import mongodbatlas:index/privateLinkEndpoint:PrivateLinkEndpoint test 1112222b3bf99403840e8934-3242342343112-AWS-us-east-1

See detailed information for arguments and attributesMongoDB API Private Endpoint Service

Create PrivateLinkEndpoint Resource

new PrivateLinkEndpoint(name: string, args: PrivateLinkEndpointArgs, opts?: CustomResourceOptions);

@overload
def PrivateLinkEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project_id: Optional[str] = None,
                        provider_name: Optional[str] = None,
                        region: Optional[str] = None)
@overload
def PrivateLinkEndpoint(resource_name: str,
                        args: PrivateLinkEndpointArgs,
                        opts: Optional[ResourceOptions] = None)

func NewPrivateLinkEndpoint(ctx *Context, name string, args PrivateLinkEndpointArgs, opts ...ResourceOption) (*PrivateLinkEndpoint, error)

public PrivateLinkEndpoint(string name, PrivateLinkEndpointArgs args, CustomResourceOptions? opts = null)

public PrivateLinkEndpoint(String name, PrivateLinkEndpointArgs args)
public PrivateLinkEndpoint(String name, PrivateLinkEndpointArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args PrivateLinkEndpointArgs: 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 PrivateLinkEndpointArgs: 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 PrivateLinkEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PrivateLinkEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PrivateLinkEndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

PrivateLinkEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The PrivateLinkEndpoint resource accepts the following input properties:

ProjectId string: Required Unique identifier for the project.
ProviderName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

ProjectId string: Required Unique identifier for the project.
ProviderName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

projectId String: Required Unique identifier for the project.
providerName String: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region String: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

projectId string: Required Unique identifier for the project.
providerName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

project_id str: Required Unique identifier for the project.
provider_name str: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region str: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

projectId String: Required Unique identifier for the project.
providerName String: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region String: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

Outputs

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

EndpointGroupNames List<string>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
Id string: The provider-assigned unique ID for this managed resource.
InterfaceEndpoints List<string>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints List<string>: All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string: Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
RegionName string: GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames List<string>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

EndpointGroupNames []string: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
Id string: The provider-assigned unique ID for this managed resource.
InterfaceEndpoints []string: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints []string: All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string: Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
RegionName string: GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames []string: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames List<String>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
id String: The provider-assigned unique ID for this managed resource.
interfaceEndpoints List<String>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
regionName String: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames string[]: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
id string: The provider-assigned unique ID for this managed resource.
interfaceEndpoints string[]: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints string[]: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId string: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId string
regionName string: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames string[]: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpoint_group_names Sequence[str]: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpoint_service_name str: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
id str: The provider-assigned unique ID for this managed resource.
interface_endpoints Sequence[str]: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
private_endpoints Sequence[str]: All private endpoints that you have added to this Azure Private Link Service.
private_link_id str: Unique identifier of the AWS PrivateLink connection.
private_link_service_name str: Name of the Azure Private Link Service that Atlas manages. GCP:
private_link_service_resource_id str
region_name str: GCP region for the Private Service Connect endpoint service.
service_attachment_names Sequence[str]: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status str: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames List<String>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
id String: The provider-assigned unique ID for this managed resource.
interfaceEndpoints List<String>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
regionName String: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

Look up Existing PrivateLinkEndpoint Resource

Get an existing PrivateLinkEndpoint 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?: PrivateLinkEndpointState, opts?: CustomResourceOptions): PrivateLinkEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_group_names: Optional[Sequence[str]] = None,
        endpoint_service_name: Optional[str] = None,
        error_message: Optional[str] = None,
        interface_endpoints: Optional[Sequence[str]] = None,
        private_endpoints: Optional[Sequence[str]] = None,
        private_link_id: Optional[str] = None,
        private_link_service_name: Optional[str] = None,
        private_link_service_resource_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        region_name: Optional[str] = None,
        service_attachment_names: Optional[Sequence[str]] = None,
        status: Optional[str] = None) -> PrivateLinkEndpoint

func GetPrivateLinkEndpoint(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointState, opts ...ResourceOption) (*PrivateLinkEndpoint, error)

public static PrivateLinkEndpoint Get(string name, Input<string> id, PrivateLinkEndpointState? state, CustomResourceOptions? opts = null)

public static PrivateLinkEndpoint get(String name, Output<String> id, PrivateLinkEndpointState 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:

EndpointGroupNames List<string>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
InterfaceEndpoints List<string>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints List<string>: All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string: Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
ProjectId string: Required Unique identifier for the project.
ProviderName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
RegionName string: GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames List<string>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

EndpointGroupNames []string: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
InterfaceEndpoints []string: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints []string: All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string: Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
ProjectId string: Required Unique identifier for the project.
ProviderName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
RegionName string: GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames []string: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames List<String>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints List<String>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
projectId String: Required Unique identifier for the project.
providerName String: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region String: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
regionName String: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames string[]: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName string: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints string[]: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints string[]: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId string: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName string: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId string
projectId string: Required Unique identifier for the project.
providerName string: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region string: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
regionName string: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames string[]: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status string: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpoint_group_names Sequence[str]: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpoint_service_name str: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interface_endpoints Sequence[str]: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
private_endpoints Sequence[str]: All private endpoints that you have added to this Azure Private Link Service.
private_link_id str: Unique identifier of the AWS PrivateLink connection.
private_link_service_name str: Name of the Azure Private Link Service that Atlas manages. GCP:
private_link_service_resource_id str
project_id str: Required Unique identifier for the project.
provider_name str: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region str: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
region_name str: GCP region for the Private Service Connect endpoint service.
service_attachment_names Sequence[str]: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status str: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

endpointGroupNames List<String>: GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String: Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String: Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints List<String>: Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>: All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String: Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String: Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
projectId String: Required Unique identifier for the project.
providerName String: Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region String: Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
regionName String: GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>: Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String: Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.