MongoDB Atlas v3.7.2, Mar 31 23
MongoDB Atlas v3.7.2, Mar 31 23
mongodbatlas.PrivateLinkEndpointService
Explore with Pulumi AI
Import
Private Endpoint Link Connection can be imported using project ID and username, in the format {project_id}--{private_link_id}--{endpoint_service_id}--{provider_name}
, e.g.
$ pulumi import mongodbatlas:index/privateLinkEndpointService:PrivateLinkEndpointService test 1112222b3bf99403840e8934--3242342343112--vpce-4242342343--AWS
See detailed information for arguments and attributesMongoDB API Private Endpoint Link Connection
Create PrivateLinkEndpointService Resource
new PrivateLinkEndpointService(name: string, args: PrivateLinkEndpointServiceArgs, opts?: CustomResourceOptions);
@overload
def PrivateLinkEndpointService(resource_name: str,
opts: Optional[ResourceOptions] = None,
endpoint_service_id: Optional[str] = None,
endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
gcp_project_id: Optional[str] = None,
private_endpoint_ip_address: Optional[str] = None,
private_link_id: Optional[str] = None,
project_id: Optional[str] = None,
provider_name: Optional[str] = None)
@overload
def PrivateLinkEndpointService(resource_name: str,
args: PrivateLinkEndpointServiceArgs,
opts: Optional[ResourceOptions] = None)
func NewPrivateLinkEndpointService(ctx *Context, name string, args PrivateLinkEndpointServiceArgs, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
public PrivateLinkEndpointService(string name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions? opts = null)
public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args)
public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions options)
type: mongodbatlas:PrivateLinkEndpointService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- 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 PrivateLinkEndpointServiceArgs
- 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 PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
PrivateLinkEndpointService 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 PrivateLinkEndpointService resource accepts the following input properties:
- Endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- Private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- Endpoints
List<Private
Link Endpoint Service Endpoint Args> Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- Gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- Endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- Private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- Endpoints
[]Private
Link Endpoint Service Endpoint Args Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- Gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service StringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- private
Link StringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- endpoints
List<Private
Link Endpoint Service Endpoint Args> Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- gcp
Project StringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- private
Endpoint StringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id string Unique identifier for the project.
- provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- endpoints
Private
Link Endpoint Service Endpoint Args[] Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint_
service_ strid Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- private_
link_ strid Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project_
id str Unique identifier for the project.
- provider_
name str Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- endpoints
Sequence[Private
Link Endpoint Service Endpoint Args] Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- gcp_
project_ strid Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- private_
endpoint_ strip_ address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service StringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- private
Link StringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.- endpoints List<Property Map>
Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- gcp
Project StringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- private
Endpoint StringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateLinkEndpointService resource produces the following output properties:
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- Delete
Requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- Endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- Id string
The provider-assigned unique ID for this managed resource.
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- Delete
Requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- Endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- Id string
The provider-assigned unique ID for this managed resource.
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status String Status of the interface endpoint for GCP. Returns one of the following values:
- id String
The provider-assigned unique ID for this managed resource.
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringResource Id Unique identifier of the private endpoint.
- aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- id string
The provider-assigned unique ID for this managed resource.
- interface
Endpoint stringId Unique identifier of the interface endpoint.
- private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint stringResource Id Unique identifier of the private endpoint.
- aws_
connection_ strstatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure_
status str Status of the interface endpoint for AZURE. Returns one of the following values:
- delete_
requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint_
group_ strname (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error_
message str Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp_
status str Status of the interface endpoint for GCP. Returns one of the following values:
- id str
The provider-assigned unique ID for this managed resource.
- interface_
endpoint_ strid Unique identifier of the interface endpoint.
- private_
endpoint_ strconnection_ name Name of the connection for this private endpoint that Atlas generates.
- private_
endpoint_ strresource_ id Unique identifier of the private endpoint.
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status String Status of the interface endpoint for GCP. Returns one of the following values:
- id String
The provider-assigned unique ID for this managed resource.
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringResource Id Unique identifier of the private endpoint.
Look up Existing PrivateLinkEndpointService Resource
Get an existing PrivateLinkEndpointService 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?: PrivateLinkEndpointServiceState, opts?: CustomResourceOptions): PrivateLinkEndpointService
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_connection_status: Optional[str] = None,
azure_status: Optional[str] = None,
delete_requested: Optional[bool] = None,
endpoint_group_name: Optional[str] = None,
endpoint_service_id: Optional[str] = None,
endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
error_message: Optional[str] = None,
gcp_project_id: Optional[str] = None,
gcp_status: Optional[str] = None,
interface_endpoint_id: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
private_endpoint_ip_address: Optional[str] = None,
private_endpoint_resource_id: Optional[str] = None,
private_link_id: Optional[str] = None,
project_id: Optional[str] = None,
provider_name: Optional[str] = None) -> PrivateLinkEndpointService
func GetPrivateLinkEndpointService(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointServiceState, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
public static PrivateLinkEndpointService Get(string name, Input<string> id, PrivateLinkEndpointServiceState? state, CustomResourceOptions? opts = null)
public static PrivateLinkEndpointService get(String name, Output<String> id, PrivateLinkEndpointServiceState 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.
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- Delete
Requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- Endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- Endpoints
List<Private
Link Endpoint Service Endpoint Args> Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- Gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- Delete
Requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- Endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- Endpoints
[]Private
Link Endpoint Service Endpoint Args Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- Gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service StringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- endpoints
List<Private
Link Endpoint Service Endpoint Args> Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project StringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- gcp
Status String Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- private
Endpoint StringResource Id Unique identifier of the private endpoint.
- private
Link StringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group stringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service stringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- endpoints
Private
Link Endpoint Service Endpoint Args[] Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project stringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- gcp
Status string Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint stringId Unique identifier of the interface endpoint.
- private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint stringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- private
Endpoint stringResource Id Unique identifier of the private endpoint.
- private
Link stringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id string Unique identifier for the project.
- provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws_
connection_ strstatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure_
status str Status of the interface endpoint for AZURE. Returns one of the following values:
- delete_
requested bool Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint_
group_ strname (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint_
service_ strid Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- endpoints
Sequence[Private
Link Endpoint Service Endpoint Args] Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- error_
message str Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp_
project_ strid Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- gcp_
status str Status of the interface endpoint for GCP. Returns one of the following values:
- interface_
endpoint_ strid Unique identifier of the interface endpoint.
- private_
endpoint_ strconnection_ name Name of the connection for this private endpoint that Atlas generates.
- private_
endpoint_ strip_ address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- private_
endpoint_ strresource_ id Unique identifier of the private endpoint.
- private_
link_ strid Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project_
id str Unique identifier for the project.
- provider_
name str Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service StringId Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource.- endpoints List<Property Map>
Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below.- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project StringId Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
.- gcp
Status String Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.- private
Endpoint StringResource Id Unique identifier of the private endpoint.
- private
Link StringId Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource.- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
Supporting Types
PrivateLinkEndpointServiceEndpoint
- Endpoint
Name string Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string Private IP address of the endpoint you created in GCP.
- Service
Attachment stringName Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- Status string
Status of the endpoint. Atlas returns one of the values shown above.
- Endpoint
Name string Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string Private IP address of the endpoint you created in GCP.
- Service
Attachment stringName Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- Status string
Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name String Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String Private IP address of the endpoint you created in GCP.
- service
Attachment StringName Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status String
Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name string Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address string Private IP address of the endpoint you created in GCP.
- service
Attachment stringName Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status string
Status of the endpoint. Atlas returns one of the values shown above.
- endpoint_
name str Forwarding rule that corresponds to the endpoint you created in GCP.
- ip_
address str Private IP address of the endpoint you created in GCP.
- service_
attachment_ strname Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status str
Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name String Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String Private IP address of the endpoint you created in GCP.
- service
Attachment StringName Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status String
Status of the endpoint. Atlas returns one of the values shown above.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.