Scaleway

v1.3.0 published on Thursday, Nov 3, 2022 by lbrlabs

getDatabaseInstance

Gets information about an RDB instance.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    var myInstance = Scaleway.GetDatabaseInstance.Invoke(new()
    {
        InstanceId = "11111111-1111-1111-1111-111111111111",
    });

});
package main

import (
	"github.com/lbrlabs/pulumi-scaleway/sdk/go/scaleway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = scaleway.LookupDatabaseInstance(ctx, &GetDatabaseInstanceArgs{
			InstanceId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetDatabaseInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myInstance = ScalewayFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
            .instanceId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}
import pulumi
import pulumi_scaleway as scaleway

my_instance = scaleway.get_database_instance(instance_id="11111111-1111-1111-1111-111111111111")
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";

// Get info by instance ID
const myInstance = pulumi.output(scaleway.getDatabaseInstance({
    instanceId: "11111111-1111-1111-1111-111111111111",
}));
variables:
  myInstance:
    fn::invoke:
      Function: scaleway:getDatabaseInstance
      Arguments:
        instanceId: 11111111-1111-1111-1111-111111111111

Using getDatabaseInstance

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 getDatabaseInstance(args: GetDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetDatabaseInstanceResult>
function getDatabaseInstanceOutput(args: GetDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetDatabaseInstanceResult>
def get_database_instance(instance_id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseInstanceResult]
func LookupDatabaseInstance(ctx *Context, args *LookupDatabaseInstanceArgs, opts ...InvokeOption) (*LookupDatabaseInstanceResult, error)
func LookupDatabaseInstanceOutput(ctx *Context, args *LookupDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupDatabaseInstanceResultOutput

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

public static class GetDatabaseInstance 
{
    public static Task<GetDatabaseInstanceResult> InvokeAsync(GetDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseInstanceResult> Invoke(GetDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: scaleway:index/getDatabaseInstance:getDatabaseInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string

The RDB instance ID. Only one of name and instance_id should be specified.

Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

InstanceId string

The RDB instance ID. Only one of name and instance_id should be specified.

Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

instanceId String

The RDB instance ID. Only one of name and instance_id should be specified.

name String

The name of the RDB instance. Only one of name and instance_id should be specified.

instanceId string

The RDB instance ID. Only one of name and instance_id should be specified.

name string

The name of the RDB instance. Only one of name and instance_id should be specified.

instance_id str

The RDB instance ID. Only one of name and instance_id should be specified.

name str

The name of the RDB instance. Only one of name and instance_id should be specified.

instanceId String

The RDB instance ID. Only one of name and instance_id should be specified.

name String

The name of the RDB instance. Only one of name and instance_id should be specified.

getDatabaseInstance Result

The following output properties are available:

backupSameRegion boolean
backupScheduleFrequency number
backupScheduleRetention number
certificate string
disableBackup boolean
endpointIp string
endpointPort number
engine string
id string

The provider-assigned unique ID for this managed resource.

initSettings {[key: string]: string}
isHaCluster boolean
loadBalancers GetDatabaseInstanceLoadBalancer[]
nodeType string
organizationId string
password string
privateNetworks GetDatabaseInstancePrivateNetwork[]
projectId string
readReplicas GetDatabaseInstanceReadReplica[]
region string
settings {[key: string]: string}
tags string[]
userName string
volumeSizeInGb number
volumeType string
instanceId string
name string
backupSameRegion Boolean
backupScheduleFrequency Number
backupScheduleRetention Number
certificate String
disableBackup Boolean
endpointIp String
endpointPort Number
engine String
id String

The provider-assigned unique ID for this managed resource.

initSettings Map<String>
isHaCluster Boolean
loadBalancers List<Property Map>
nodeType String
organizationId String
password String
privateNetworks List<Property Map>
projectId String
readReplicas List<Property Map>
region String
settings Map<String>
tags List<String>
userName String
volumeSizeInGb Number
volumeType String
instanceId String
name String

Supporting Types

GetDatabaseInstanceLoadBalancer

EndpointId string
Hostname string
Ip string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

Port int
EndpointId string
Hostname string
Ip string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

Port int
endpointId String
hostname String
ip String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

port Integer
endpointId string
hostname string
ip string
name string

The name of the RDB instance. Only one of name and instance_id should be specified.

port number
endpoint_id str
hostname str
ip str
name str

The name of the RDB instance. Only one of name and instance_id should be specified.

port int
endpointId String
hostname String
ip String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

port Number

GetDatabaseInstancePrivateNetwork

EndpointId string
Hostname string
Ip string
IpNet string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

PnId string
Port int
Zone string
EndpointId string
Hostname string
Ip string
IpNet string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

PnId string
Port int
Zone string
endpointId String
hostname String
ip String
ipNet String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

pnId String
port Integer
zone String
endpointId string
hostname string
ip string
ipNet string
name string

The name of the RDB instance. Only one of name and instance_id should be specified.

pnId string
port number
zone string
endpoint_id str
hostname str
ip str
ip_net str
name str

The name of the RDB instance. Only one of name and instance_id should be specified.

pn_id str
port int
zone str
endpointId String
hostname String
ip String
ipNet String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

pnId String
port Number
zone String

GetDatabaseInstanceReadReplica

Ip string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

Port int
Ip string
Name string

The name of the RDB instance. Only one of name and instance_id should be specified.

Port int
ip String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

port Integer
ip string
name string

The name of the RDB instance. Only one of name and instance_id should be specified.

port number
ip str
name str

The name of the RDB instance. Only one of name and instance_id should be specified.

port int
ip String
name String

The name of the RDB instance. Only one of name and instance_id should be specified.

port Number

Package Details

Repository
https://github.com/lbrlabs/pulumi-scaleway
License
Apache-2.0
Notes

This Pulumi package is based on the scaleway Terraform Provider.