Scaleway v1.26.0, Mar 28 25

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.getDatabaseInstance

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

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.

TypeScript
Python
Go
C#
Java
YAML

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,
                          project_id: Optional[str] = None,
                          region: 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,
                          project_id: Optional[pulumi.Input[str]] = None,
                          region: 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)
public static Output<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:index/getDatabaseInstance:getDatabaseInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
Name string: The name of the RDB instance.
ProjectId string: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
Region string: region) The region in which the Database Instance exists.

InstanceId string: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
Name string: The name of the RDB instance.
ProjectId string: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
Region string: region) The region in which the Database Instance exists.

instanceId String: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
name String: The name of the RDB instance.
projectId String: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
region String: region) The region in which the Database Instance exists.

instanceId string: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
name string: The name of the RDB instance.
projectId string: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
region string: region) The region in which the Database Instance exists.

instance_id str: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
name str: The name of the RDB instance.
project_id str: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
region str: region) The region in which the Database Instance exists.

instanceId String: The RDB instance ID.
Note You must specify at least one: name and/or instance_id.
name String: The name of the RDB instance.
projectId String: The ID of the project the Database Instance is in. Can be used to filter instances when using name.
region String: region) The region in which the Database Instance exists.

getDatabaseInstance Result

The following output properties are available:

BackupSameRegion bool
BackupScheduleFrequency int
BackupScheduleRetention int
Certificate string
DisableBackup bool
EncryptionAtRest bool
EndpointIp string
EndpointPort int
Engine string
Id string: The provider-assigned unique ID for this managed resource.
InitSettings Dictionary<string, string>
IsHaCluster bool
LoadBalancers List<Pulumiverse.Scaleway.Outputs.GetDatabaseInstanceLoadBalancer>
LogsPolicies List<Pulumiverse.Scaleway.Outputs.GetDatabaseInstanceLogsPolicy>
NodeType string
OrganizationId string
Password string
PrivateNetworks List<Pulumiverse.Scaleway.Outputs.GetDatabaseInstancePrivateNetwork>
ReadReplicas List<Pulumiverse.Scaleway.Outputs.GetDatabaseInstanceReadReplica>
Settings Dictionary<string, string>
SnapshotId string
Tags List<string>
UserName string
VolumeSizeInGb int
VolumeType string
InstanceId string
Name string
ProjectId string
Region string

BackupSameRegion bool
BackupScheduleFrequency int
BackupScheduleRetention int
Certificate string
DisableBackup bool
EncryptionAtRest bool
EndpointIp string
EndpointPort int
Engine string
Id string: The provider-assigned unique ID for this managed resource.
InitSettings map[string]string
IsHaCluster bool
LoadBalancers []GetDatabaseInstanceLoadBalancer
LogsPolicies []GetDatabaseInstanceLogsPolicy
NodeType string
OrganizationId string
Password string
PrivateNetworks []GetDatabaseInstancePrivateNetwork
ReadReplicas []GetDatabaseInstanceReadReplica
Settings map[string]string
SnapshotId string
Tags []string
UserName string
VolumeSizeInGb int
VolumeType string
InstanceId string
Name string
ProjectId string
Region string

backupSameRegion Boolean
backupScheduleFrequency Integer
backupScheduleRetention Integer
certificate String
disableBackup Boolean
encryptionAtRest Boolean
endpointIp String
endpointPort Integer
engine String
id String: The provider-assigned unique ID for this managed resource.
initSettings Map<String,String>
isHaCluster Boolean
loadBalancers List<GetDatabaseInstanceLoadBalancer>
logsPolicies List<GetDatabaseInstanceLogsPolicy>
nodeType String
organizationId String
password String
privateNetworks List<GetDatabaseInstancePrivateNetwork>
readReplicas List<GetDatabaseInstanceReadReplica>
settings Map<String,String>
snapshotId String
tags List<String>
userName String
volumeSizeInGb Integer
volumeType String
instanceId String
name String
projectId String
region String

backupSameRegion boolean
backupScheduleFrequency number
backupScheduleRetention number
certificate string
disableBackup boolean
encryptionAtRest 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[]
logsPolicies GetDatabaseInstanceLogsPolicy[]
nodeType string
organizationId string
password string
privateNetworks GetDatabaseInstancePrivateNetwork[]
readReplicas GetDatabaseInstanceReadReplica[]
settings {[key: string]: string}
snapshotId string
tags string[]
userName string
volumeSizeInGb number
volumeType string
instanceId string
name string
projectId string
region string

backup_same_region bool
backup_schedule_frequency int
backup_schedule_retention int
certificate str
disable_backup bool
encryption_at_rest bool
endpoint_ip str
endpoint_port int
engine str
id str: The provider-assigned unique ID for this managed resource.
init_settings Mapping[str, str]
is_ha_cluster bool
load_balancers Sequence[GetDatabaseInstanceLoadBalancer]
logs_policies Sequence[GetDatabaseInstanceLogsPolicy]
node_type str
organization_id str
password str
private_networks Sequence[GetDatabaseInstancePrivateNetwork]
read_replicas Sequence[GetDatabaseInstanceReadReplica]
settings Mapping[str, str]
snapshot_id str
tags Sequence[str]
user_name str
volume_size_in_gb int
volume_type str
instance_id str
name str
project_id str
region str

backupSameRegion Boolean
backupScheduleFrequency Number
backupScheduleRetention Number
certificate String
disableBackup Boolean
encryptionAtRest 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>
logsPolicies List<Property Map>
nodeType String
organizationId String
password String
privateNetworks List<Property Map>
readReplicas List<Property Map>
settings Map<String>
snapshotId String
tags List<String>
userName String
volumeSizeInGb Number
volumeType String
instanceId String
name String
projectId String
region String

Supporting Types

GetDatabaseInstanceLoadBalancer

EndpointId string: The endpoint ID
Hostname string: The hostname of your endpoint
Ip string: The IP of your load balancer service
Name string: The name of the RDB instance.
Port int: The port of your load balancer service

EndpointId string: The endpoint ID
Hostname string: The hostname of your endpoint
Ip string: The IP of your load balancer service
Name string: The name of the RDB instance.
Port int: The port of your load balancer service

endpointId String: The endpoint ID
hostname String: The hostname of your endpoint
ip String: The IP of your load balancer service
name String: The name of the RDB instance.
port Integer: The port of your load balancer service

endpointId string: The endpoint ID
hostname string: The hostname of your endpoint
ip string: The IP of your load balancer service
name string: The name of the RDB instance.
port number: The port of your load balancer service

endpoint_id str: The endpoint ID
hostname str: The hostname of your endpoint
ip str: The IP of your load balancer service
name str: The name of the RDB instance.
port int: The port of your load balancer service

endpointId String: The endpoint ID
hostname String: The hostname of your endpoint
ip String: The IP of your load balancer service
name String: The name of the RDB instance.
port Number: The port of your load balancer service

GetDatabaseInstanceLogsPolicy

MaxAgeRetention int: The max age (in days) of remote logs to keep on the Database Instance
TotalDiskRetention int: The max disk size of remote logs to keep on the Database Instance.

MaxAgeRetention int: The max age (in days) of remote logs to keep on the Database Instance
TotalDiskRetention int: The max disk size of remote logs to keep on the Database Instance.

maxAgeRetention Integer: The max age (in days) of remote logs to keep on the Database Instance
totalDiskRetention Integer: The max disk size of remote logs to keep on the Database Instance.

maxAgeRetention number: The max age (in days) of remote logs to keep on the Database Instance
totalDiskRetention number: The max disk size of remote logs to keep on the Database Instance.

max_age_retention int: The max age (in days) of remote logs to keep on the Database Instance
total_disk_retention int: The max disk size of remote logs to keep on the Database Instance.

maxAgeRetention Number: The max age (in days) of remote logs to keep on the Database Instance
totalDiskRetention Number: The max disk size of remote logs to keep on the Database Instance.

GetDatabaseInstancePrivateNetwork

EnableIpam bool: Whether or not the private network endpoint should be configured with IPAM
EndpointId string: The endpoint ID
Hostname string: The hostname of your endpoint
Ip string: The IP of your Instance within the private service
IpNet string: The IP with the given mask within the private subnet
Name string: The name of the RDB instance.
PnId string: The private network ID
Port int: The port of your private service
Zone string: The zone you want to attach the resource to

EnableIpam bool: Whether or not the private network endpoint should be configured with IPAM
EndpointId string: The endpoint ID
Hostname string: The hostname of your endpoint
Ip string: The IP of your Instance within the private service
IpNet string: The IP with the given mask within the private subnet
Name string: The name of the RDB instance.
PnId string: The private network ID
Port int: The port of your private service
Zone string: The zone you want to attach the resource to

enableIpam Boolean: Whether or not the private network endpoint should be configured with IPAM
endpointId String: The endpoint ID
hostname String: The hostname of your endpoint
ip String: The IP of your Instance within the private service
ipNet String: The IP with the given mask within the private subnet
name String: The name of the RDB instance.
pnId String: The private network ID
port Integer: The port of your private service
zone String: The zone you want to attach the resource to

enableIpam boolean: Whether or not the private network endpoint should be configured with IPAM
endpointId string: The endpoint ID
hostname string: The hostname of your endpoint
ip string: The IP of your Instance within the private service
ipNet string: The IP with the given mask within the private subnet
name string: The name of the RDB instance.
pnId string: The private network ID
port number: The port of your private service
zone string: The zone you want to attach the resource to

enable_ipam bool: Whether or not the private network endpoint should be configured with IPAM
endpoint_id str: The endpoint ID
hostname str: The hostname of your endpoint
ip str: The IP of your Instance within the private service
ip_net str: The IP with the given mask within the private subnet
name str: The name of the RDB instance.
pn_id str: The private network ID
port int: The port of your private service
zone str: The zone you want to attach the resource to

enableIpam Boolean: Whether or not the private network endpoint should be configured with IPAM
endpointId String: The endpoint ID
hostname String: The hostname of your endpoint
ip String: The IP of your Instance within the private service
ipNet String: The IP with the given mask within the private subnet
name String: The name of the RDB instance.
pnId String: The private network ID
port Number: The port of your private service
zone String: The zone you want to attach the resource to

GetDatabaseInstanceReadReplica

Ip string: IP of the replica
Name string: The name of the RDB instance.
Port int: Port of the replica

Ip string: IP of the replica
Name string: The name of the RDB instance.
Port int: Port of the replica

ip String: IP of the replica
name String: The name of the RDB instance.
port Integer: Port of the replica

ip string: IP of the replica
name string: The name of the RDB instance.
port number: Port of the replica

ip str: IP of the replica
name str: The name of the RDB instance.
port int: Port of the replica

ip String: IP of the replica
name String: The name of the RDB instance.
port Number: Port of the replica

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.getDatabaseInstance

On this page

On this page

Using getDatabaseInstance

getDatabaseInstance Result

Supporting Types

GetDatabaseInstanceLoadBalancer

GetDatabaseInstanceLogsPolicy

GetDatabaseInstancePrivateNetwork

GetDatabaseInstanceReadReplica

Package Details

On this page

On this page