published on Monday, Jun 15, 2026 by Volcengine
published on Monday, Jun 15, 2026 by Volcengine
Data Source schema for Volcengine::MongoDB::Endpoint
Using getEndpoint
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>def get_endpoint(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput> Note: This function is named LookupEndpoint in the Go SDK.
public static class GetEndpoint
{
public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
fn::invoke:
function: volcenginecc:mongodb/getEndpoint:getEndpoint
arguments:
# arguments dictionarydata "volcenginecc_mongodb_getendpoint" "name" {
# arguments
}The following arguments are supported:
- Id string
- Id string
- id string
- id String
- id string
- id str
- id String
getEndpoint Result
The following output properties are available:
- Db
Addresses List<Volcengine.Get Endpoint Db Address> - Eip
Ids List<string> - Endpoint
Id string - Endpoint
Str string - Endpoint
Type string - Id string
- Instance
Id string - Mongos
Node List<string>Ids - Network
Type string - Object
Id string - Subnet
Id string - Vpc
Id string
- Db
Addresses []GetEndpoint Db Address - Eip
Ids []string - Endpoint
Id string - Endpoint
Str string - Endpoint
Type string - Id string
- Instance
Id string - Mongos
Node []stringIds - Network
Type string - Object
Id string - Subnet
Id string - Vpc
Id string
- db_
addresses list(object) - eip_
ids list(string) - endpoint_
id string - endpoint_
str string - endpoint_
type string - id string
- instance_
id string - mongos_
node_ list(string)ids - network_
type string - object_
id string - subnet_
id string - vpc_
id string
- db
Addresses List<GetEndpoint Db Address> - eip
Ids List<String> - endpoint
Id String - endpoint
Str String - endpoint
Type String - id String
- instance
Id String - mongos
Node List<String>Ids - network
Type String - object
Id String - subnet
Id String - vpc
Id String
- db
Addresses GetEndpoint Db Address[] - eip
Ids string[] - endpoint
Id string - endpoint
Str string - endpoint
Type string - id string
- instance
Id string - mongos
Node string[]Ids - network
Type string - object
Id string - subnet
Id string - vpc
Id string
- db_
addresses Sequence[GetEndpoint Db Address] - eip_
ids Sequence[str] - endpoint_
id str - endpoint_
str str - endpoint_
type str - id str
- instance_
id str - mongos_
node_ Sequence[str]ids - network_
type str - object_
id str - subnet_
id str - vpc_
id str
- db
Addresses List<Property Map> - eip
Ids List<String> - endpoint
Id String - endpoint
Str String - endpoint
Type String - id String
- instance
Id String - mongos
Node List<String>Ids - network
Type String - object
Id String - subnet
Id String - vpc
Id String
Supporting Types
GetEndpointDbAddress
- Address
Domain string - Domain name of the connection address
- Address
Ip string IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- Address
Port string - Port number of the connection address
- Address
Type string Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- Eip
Id string EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- Node
Id string - Node ID associated with the connection address
- Zone
Id string - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- Address
Domain string - Domain name of the connection address
- Address
Ip string IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- Address
Port string - Port number of the connection address
- Address
Type string Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- Eip
Id string EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- Node
Id string - Node ID associated with the connection address
- Zone
Id string - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- address_
domain string - Domain name of the connection address
- address_
ip string IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- address_
port string - Port number of the connection address
- address_
type string Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- eip_
id string EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- node_
id string - Node ID associated with the connection address
- zone_
id string - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- address
Domain String - Domain name of the connection address
- address
Ip String IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- address
Port String - Port number of the connection address
- address
Type String Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- eip
Id String EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- node
Id String - Node ID associated with the connection address
- zone
Id String - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- address
Domain string - Domain name of the connection address
- address
Ip string IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- address
Port string - Port number of the connection address
- address
Type string Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- eip
Id string EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- node
Id string - Node ID associated with the connection address
- zone
Id string - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- address_
domain str - Domain name of the connection address
- address_
ip str IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- address_
port str - Port number of the connection address
- address_
type str Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- eip_
id str EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- node_
id str - Node ID associated with the connection address
- zone_
id str - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
- address
Domain String - Domain name of the connection address
- address
Ip String IP corresponding to the connection address
Note: It is not recommended to connect to the instance using the
IP:portformat, as the IP address may change after switching subnets. If the client code is not updated in time, instance connection failures may occur. We recommend accessing the MongoDB instance using thedomain:portformat to avoid connection issues caused by IP address changes. For detailed steps to connect to a MongoDB instance, see Connect to an Instance Using the Mongo Shell Tool.- address
Port String - Port number of the connection address
- address
Type String Connection address type of the node. Possible values:
Primary: Primary node connection address Secondary: Secondary node connection address Hidden: Hidden node connection address ReadOnly: Read-only node connection address
Note: Hidden node connection address information is returned only when the connection address type is a private connection address (that is, when
NetworkTypeis set toPrivate).- eip
Id String EIP ID bound to the instance's public address
Note: This parameter is returned only when the connection address type is a public connection address (that is, when
NetworkTypeis set toPublic).- node
Id String - Node ID associated with the connection address
- zone
Id String - AZ of the node; all nodes are consistent for single-AZ instances, while nodes differ for multi-AZ instances
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Monday, Jun 15, 2026 by Volcengine