MongoDB Atlas v3.7.2, Mar 31 23
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:
- Project
Id string Required Unique identifier for the project.
- Provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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 string Required Unique identifier for the project.
- Provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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 String Required Unique identifier for the project.
- provider
Name String Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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 string Required Unique identifier for the project.
- provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
orGCP
.- 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
- project
Id String Required Unique identifier for the project.
- provider
Name String Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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:
- Endpoint
Group List<string>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message 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.
- Interface
Endpoints List<string> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- Private
Endpoints List<string> All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId Unique identifier of the AWS PrivateLink connection.
- Private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- Private
Link stringService Resource Id - Region
Name string GCP region for the Private Service Connect endpoint service.
- Service
Attachment List<string>Names 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 []stringNames GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message 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.
- Interface
Endpoints []string Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- Private
Endpoints []string All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId Unique identifier of the AWS PrivateLink connection.
- Private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- Private
Link stringService Resource Id - Region
Name string GCP region for the Private Service Connect endpoint service.
- Service
Attachment []stringNames 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 List<String>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints List<String> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints List<String> All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId Unique identifier of the AWS PrivateLink connection.
- private
Link StringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link StringService Resource Id - region
Name String GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names 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 string[]Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints string[] Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints string[] All private endpoints that you have added to this Azure Private Link Service.
- private
Link stringId Unique identifier of the AWS PrivateLink connection.
- private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link stringService Resource Id - region
Name string GCP region for the Private Service Connect endpoint service.
- service
Attachment string[]Names 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_ Sequence[str]names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint_
service_ strname 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_ strid Unique identifier of the AWS PrivateLink connection.
- private_
link_ strservice_ name Name of the Azure Private Link Service that Atlas manages. GCP:
- private_
link_ strservice_ resource_ id - region_
name str GCP region for the Private Service Connect endpoint service.
- service_
attachment_ Sequence[str]names 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:
- endpoint
Group List<String>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints List<String> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints List<String> All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId Unique identifier of the AWS PrivateLink connection.
- private
Link StringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link StringService Resource Id - region
Name String GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names 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.
- Endpoint
Group List<string>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
- Interface
Endpoints List<string> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- Private
Endpoints List<string> All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId Unique identifier of the AWS PrivateLink connection.
- Private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- Private
Link stringService Resource Id - Project
Id string Required Unique identifier for the project.
- Provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
- Region
Name string GCP region for the Private Service Connect endpoint service.
- Service
Attachment List<string>Names 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 []stringNames GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
- Interface
Endpoints []string Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- Private
Endpoints []string All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId Unique identifier of the AWS PrivateLink connection.
- Private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- Private
Link stringService Resource Id - Project
Id string Required Unique identifier for the project.
- Provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
- Region
Name string GCP region for the Private Service Connect endpoint service.
- Service
Attachment []stringNames 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 List<String>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message String Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
- interface
Endpoints List<String> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints List<String> All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId Unique identifier of the AWS PrivateLink connection.
- private
Link StringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link StringService Resource Id - project
Id String Required Unique identifier for the project.
- provider
Name String Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
- region
Name String GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names 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 string[]Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service stringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
- interface
Endpoints string[] Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints string[] All private endpoints that you have added to this Azure Private Link Service.
- private
Link stringId Unique identifier of the AWS PrivateLink connection.
- private
Link stringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link stringService Resource Id - project
Id string Required Unique identifier for the project.
- provider
Name string Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
- region
Name string GCP region for the Private Service Connect endpoint service.
- service
Attachment string[]Names 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_ Sequence[str]names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint_
service_ strname 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_ strid Unique identifier of the AWS PrivateLink connection.
- private_
link_ strservice_ name Name of the Azure Private Link Service that Atlas manages. GCP:
- private_
link_ strservice_ resource_ id - 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
orGCP
.- 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_ Sequence[str]names 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:
- endpoint
Group List<String>Names GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message String Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
- interface
Endpoints List<String> Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
- private
Endpoints List<String> All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId Unique identifier of the AWS PrivateLink connection.
- private
Link StringService Name Name of the Azure Private Link Service that Atlas manages. GCP:
- private
Link StringService Resource Id - project
Id String Required Unique identifier for the project.
- provider
Name String Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.- 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
- region
Name String GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names 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.