Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. mongodb
  5. getInstance
Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.mongodb.getInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    Gets information about a MongoDB® Instance.

    For further information refer to the Managed Databases for MongoDB® API documentation

    Using getInstance

    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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_id: Optional[str] = None,
                 name: Optional[str] = None,
                 project_id: Optional[str] = None,
                 region: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 project_id: Optional[pulumi.Input[str]] = None,
                 region: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: scaleway:mongodb/getInstance:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    Name string
    The name of the MongoDB® instance.
    ProjectId string
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    Region string
    region) The region in which the MongoDB® Instance exists.
    InstanceId string

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    Name string
    The name of the MongoDB® instance.
    ProjectId string
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    Region string
    region) The region in which the MongoDB® Instance exists.
    instanceId String

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    name String
    The name of the MongoDB® instance.
    projectId String
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    region String
    region) The region in which the MongoDB® Instance exists.
    instanceId string

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    name string
    The name of the MongoDB® instance.
    projectId string
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    region string
    region) The region in which the MongoDB® Instance exists.
    instance_id str

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    name str
    The name of the MongoDB® instance.
    project_id str
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    region str
    region) The region in which the MongoDB® Instance exists.
    instanceId String

    The MongoDB® instance ID.

    Note You must specify at least one: name or instance_id.

    name String
    The name of the MongoDB® instance.
    projectId String
    The ID of the project the MongoDB® instance is in. Can be used to filter instances when using name.
    region String
    region) The region in which the MongoDB® Instance exists.

    getInstance Result

    The following output properties are available:

    CreatedAt string
    The date and time the MongoDB® instance was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeNumber int
    The number of nodes in the MongoDB® cluster.
    NodeType string
    The type of MongoDB® node.
    Password string
    PrivateNetworks List<Pulumiverse.Scaleway.Mongodb.Outputs.GetInstancePrivateNetwork>
    PublicNetworks List<Pulumiverse.Scaleway.Mongodb.Outputs.GetInstancePublicNetwork>
    The details of the public network configuration, if applicable.
    Settings Dictionary<string, string>
    SnapshotId string
    Tags List<string>
    A list of tags attached to the MongoDB® instance.
    UpdatedAt string
    UserName string
    Version string
    The version of MongoDB® running on the instance.
    VolumeSizeInGb int
    The size of the attached volume, in GB.
    VolumeType string
    The type of volume attached to the MongoDB® instance.
    InstanceId string
    Name string
    The name of the MongoDB® instance.
    ProjectId string
    The ID of the project the instance belongs to.
    Region string
    CreatedAt string
    The date and time the MongoDB® instance was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeNumber int
    The number of nodes in the MongoDB® cluster.
    NodeType string
    The type of MongoDB® node.
    Password string
    PrivateNetworks []GetInstancePrivateNetwork
    PublicNetworks []GetInstancePublicNetwork
    The details of the public network configuration, if applicable.
    Settings map[string]string
    SnapshotId string
    Tags []string
    A list of tags attached to the MongoDB® instance.
    UpdatedAt string
    UserName string
    Version string
    The version of MongoDB® running on the instance.
    VolumeSizeInGb int
    The size of the attached volume, in GB.
    VolumeType string
    The type of volume attached to the MongoDB® instance.
    InstanceId string
    Name string
    The name of the MongoDB® instance.
    ProjectId string
    The ID of the project the instance belongs to.
    Region string
    createdAt String
    The date and time the MongoDB® instance was created.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeNumber Integer
    The number of nodes in the MongoDB® cluster.
    nodeType String
    The type of MongoDB® node.
    password String
    privateNetworks List<GetInstancePrivateNetwork>
    publicNetworks List<GetInstancePublicNetwork>
    The details of the public network configuration, if applicable.
    settings Map<String,String>
    snapshotId String
    tags List<String>
    A list of tags attached to the MongoDB® instance.
    updatedAt String
    userName String
    version String
    The version of MongoDB® running on the instance.
    volumeSizeInGb Integer
    The size of the attached volume, in GB.
    volumeType String
    The type of volume attached to the MongoDB® instance.
    instanceId String
    name String
    The name of the MongoDB® instance.
    projectId String
    The ID of the project the instance belongs to.
    region String
    createdAt string
    The date and time the MongoDB® instance was created.
    id string
    The provider-assigned unique ID for this managed resource.
    nodeNumber number
    The number of nodes in the MongoDB® cluster.
    nodeType string
    The type of MongoDB® node.
    password string
    privateNetworks GetInstancePrivateNetwork[]
    publicNetworks GetInstancePublicNetwork[]
    The details of the public network configuration, if applicable.
    settings {[key: string]: string}
    snapshotId string
    tags string[]
    A list of tags attached to the MongoDB® instance.
    updatedAt string
    userName string
    version string
    The version of MongoDB® running on the instance.
    volumeSizeInGb number
    The size of the attached volume, in GB.
    volumeType string
    The type of volume attached to the MongoDB® instance.
    instanceId string
    name string
    The name of the MongoDB® instance.
    projectId string
    The ID of the project the instance belongs to.
    region string
    created_at str
    The date and time the MongoDB® instance was created.
    id str
    The provider-assigned unique ID for this managed resource.
    node_number int
    The number of nodes in the MongoDB® cluster.
    node_type str
    The type of MongoDB® node.
    password str
    private_networks Sequence[GetInstancePrivateNetwork]
    public_networks Sequence[GetInstancePublicNetwork]
    The details of the public network configuration, if applicable.
    settings Mapping[str, str]
    snapshot_id str
    tags Sequence[str]
    A list of tags attached to the MongoDB® instance.
    updated_at str
    user_name str
    version str
    The version of MongoDB® running on the instance.
    volume_size_in_gb int
    The size of the attached volume, in GB.
    volume_type str
    The type of volume attached to the MongoDB® instance.
    instance_id str
    name str
    The name of the MongoDB® instance.
    project_id str
    The ID of the project the instance belongs to.
    region str
    createdAt String
    The date and time the MongoDB® instance was created.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeNumber Number
    The number of nodes in the MongoDB® cluster.
    nodeType String
    The type of MongoDB® node.
    password String
    privateNetworks List<Property Map>
    publicNetworks List<Property Map>
    The details of the public network configuration, if applicable.
    settings Map<String>
    snapshotId String
    tags List<String>
    A list of tags attached to the MongoDB® instance.
    updatedAt String
    userName String
    version String
    The version of MongoDB® running on the instance.
    volumeSizeInGb Number
    The size of the attached volume, in GB.
    volumeType String
    The type of volume attached to the MongoDB® instance.
    instanceId String
    name String
    The name of the MongoDB® instance.
    projectId String
    The ID of the project the instance belongs to.
    region String

    Supporting Types

    GetInstancePrivateNetwork

    DnsRecords List<string>
    List of DNS records for your endpoint
    Id string
    The ID of the MongoDB® Instance.
    Ips List<string>
    List of IP addresses for your endpoint
    PnId string
    The private network ID
    Port int
    TCP port of the endpoint
    DnsRecords []string
    List of DNS records for your endpoint
    Id string
    The ID of the MongoDB® Instance.
    Ips []string
    List of IP addresses for your endpoint
    PnId string
    The private network ID
    Port int
    TCP port of the endpoint
    dnsRecords List<String>
    List of DNS records for your endpoint
    id String
    The ID of the MongoDB® Instance.
    ips List<String>
    List of IP addresses for your endpoint
    pnId String
    The private network ID
    port Integer
    TCP port of the endpoint
    dnsRecords string[]
    List of DNS records for your endpoint
    id string
    The ID of the MongoDB® Instance.
    ips string[]
    List of IP addresses for your endpoint
    pnId string
    The private network ID
    port number
    TCP port of the endpoint
    dns_records Sequence[str]
    List of DNS records for your endpoint
    id str
    The ID of the MongoDB® Instance.
    ips Sequence[str]
    List of IP addresses for your endpoint
    pn_id str
    The private network ID
    port int
    TCP port of the endpoint
    dnsRecords List<String>
    List of DNS records for your endpoint
    id String
    The ID of the MongoDB® Instance.
    ips List<String>
    List of IP addresses for your endpoint
    pnId String
    The private network ID
    port Number
    TCP port of the endpoint

    GetInstancePublicNetwork

    DnsRecord string
    The DNS record of your endpoint
    Id string
    The ID of the MongoDB® Instance.
    Port int
    TCP port of the endpoint
    DnsRecord string
    The DNS record of your endpoint
    Id string
    The ID of the MongoDB® Instance.
    Port int
    TCP port of the endpoint
    dnsRecord String
    The DNS record of your endpoint
    id String
    The ID of the MongoDB® Instance.
    port Integer
    TCP port of the endpoint
    dnsRecord string
    The DNS record of your endpoint
    id string
    The ID of the MongoDB® Instance.
    port number
    TCP port of the endpoint
    dns_record str
    The DNS record of your endpoint
    id str
    The ID of the MongoDB® Instance.
    port int
    TCP port of the endpoint
    dnsRecord String
    The DNS record of your endpoint
    id String
    The ID of the MongoDB® Instance.
    port Number
    TCP port of the endpoint

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway