MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.PrivatelinkEndpointServiceServerless

Explore with Pulumi AI

Import

Serverless privatelink endpoint can be imported using project ID and endpoint ID, in the format project_id–endpoint_id, e.g.

 $ pulumi import mongodbatlas:index/privatelinkEndpointServiceServerless:PrivatelinkEndpointServiceServerless test 1112222b3bf99403840e8934--serverless_name--vpce-jjg5e24qp93513h03

For more information seeMongoDB Atlas API - Serverless Private Endpoints.

Create PrivatelinkEndpointServiceServerless Resource

new PrivatelinkEndpointServiceServerless(name: string, args: PrivatelinkEndpointServiceServerlessArgs, opts?: CustomResourceOptions);

@overload
def PrivatelinkEndpointServiceServerless(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         cloud_provider_endpoint_id: Optional[str] = None,
                                         comment: Optional[str] = None,
                                         endpoint_id: Optional[str] = None,
                                         instance_name: Optional[str] = None,
                                         private_endpoint_ip_address: Optional[str] = None,
                                         project_id: Optional[str] = None,
                                         provider_name: Optional[str] = None)
@overload
def PrivatelinkEndpointServiceServerless(resource_name: str,
                                         args: PrivatelinkEndpointServiceServerlessArgs,
                                         opts: Optional[ResourceOptions] = None)

func NewPrivatelinkEndpointServiceServerless(ctx *Context, name string, args PrivatelinkEndpointServiceServerlessArgs, opts ...ResourceOption) (*PrivatelinkEndpointServiceServerless, error)

public PrivatelinkEndpointServiceServerless(string name, PrivatelinkEndpointServiceServerlessArgs args, CustomResourceOptions? opts = null)

public PrivatelinkEndpointServiceServerless(String name, PrivatelinkEndpointServiceServerlessArgs args)
public PrivatelinkEndpointServiceServerless(String name, PrivatelinkEndpointServiceServerlessArgs args, CustomResourceOptions options)

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

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

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

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

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

EndpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
InstanceName string: Human-readable label that identifies the serverless instance.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
CloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
Comment string: Human-readable string to associate with this private endpoint.
PrivateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

EndpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
InstanceName string: Human-readable label that identifies the serverless instance.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
CloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
Comment string: Human-readable string to associate with this private endpoint.
PrivateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

endpointId String: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName String: Human-readable label that identifies the serverless instance.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
cloudProviderEndpointId String: Unique string that identifies the private endpoint's network interface.
comment String: Human-readable string to associate with this private endpoint.
privateEndpointIpAddress String: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

endpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName string: Human-readable label that identifies the serverless instance.
projectId string: Unique 24-digit hexadecimal string that identifies the project.
providerName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
cloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
comment string: Human-readable string to associate with this private endpoint.
privateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

endpoint_id str: Unique 24-hexadecimal digit string that identifies the private endpoint.
instance_name str: Human-readable label that identifies the serverless instance.
project_id str: Unique 24-digit hexadecimal string that identifies the project.
provider_name str: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
cloud_provider_endpoint_id str: Unique string that identifies the private endpoint's network interface.
comment str: Human-readable string to associate with this private endpoint.
private_endpoint_ip_address str: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

endpointId String: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName String: Human-readable label that identifies the serverless instance.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
cloudProviderEndpointId String: Unique string that identifies the private endpoint's network interface.
comment String: Human-readable string to associate with this private endpoint.
privateEndpointIpAddress String: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
PrivateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
Status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

Id string: The provider-assigned unique ID for this managed resource.
PrivateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
Status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

id String: The provider-assigned unique ID for this managed resource.
privateLinkServiceResourceId String: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
status String: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

id string: The provider-assigned unique ID for this managed resource.
privateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

id str: The provider-assigned unique ID for this managed resource.
private_link_service_resource_id str: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
status str: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

id String: The provider-assigned unique ID for this managed resource.
privateLinkServiceResourceId String: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
status String: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

Look up Existing PrivatelinkEndpointServiceServerless Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider_endpoint_id: Optional[str] = None,
        comment: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        private_endpoint_ip_address: Optional[str] = None,
        private_link_service_resource_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        status: Optional[str] = None) -> PrivatelinkEndpointServiceServerless

func GetPrivatelinkEndpointServiceServerless(ctx *Context, name string, id IDInput, state *PrivatelinkEndpointServiceServerlessState, opts ...ResourceOption) (*PrivatelinkEndpointServiceServerless, error)

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

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

CloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
Comment string: Human-readable string to associate with this private endpoint.
EndpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
InstanceName string: Human-readable label that identifies the serverless instance.
PrivateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
PrivateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
Status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

CloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
Comment string: Human-readable string to associate with this private endpoint.
EndpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
InstanceName string: Human-readable label that identifies the serverless instance.
PrivateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
PrivateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
Status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

cloudProviderEndpointId String: Unique string that identifies the private endpoint's network interface.
comment String: Human-readable string to associate with this private endpoint.
endpointId String: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName String: Human-readable label that identifies the serverless instance.
privateEndpointIpAddress String: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
privateLinkServiceResourceId String: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
status String: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

cloudProviderEndpointId string: Unique string that identifies the private endpoint's network interface.
comment string: Human-readable string to associate with this private endpoint.
endpointId string: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName string: Human-readable label that identifies the serverless instance.
privateEndpointIpAddress string: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
privateLinkServiceResourceId string: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
projectId string: Unique 24-digit hexadecimal string that identifies the project.
providerName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
status string: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

cloud_provider_endpoint_id str: Unique string that identifies the private endpoint's network interface.
comment str: Human-readable string to associate with this private endpoint.
endpoint_id str: Unique 24-hexadecimal digit string that identifies the private endpoint.
instance_name str: Human-readable label that identifies the serverless instance.
private_endpoint_ip_address str: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
private_link_service_resource_id str: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
project_id str: Unique 24-digit hexadecimal string that identifies the project.
provider_name str: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
status str: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

cloudProviderEndpointId String: Unique string that identifies the private endpoint's network interface.
comment String: Human-readable string to associate with this private endpoint.
endpointId String: Unique 24-hexadecimal digit string that identifies the private endpoint.
instanceName String: Human-readable label that identifies the serverless instance.
privateEndpointIpAddress String: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
privateLinkServiceResourceId String: Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE.
status String: Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

Package Details

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