1. Packages
  2. Scaleway
  3. API Docs
  4. getDatabaseInstance
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

scaleway.getDatabaseInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

    Gets information about an RDB instance. For further information see our developers website

    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,
                              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)
    // 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.
    ProjectId string
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    Region string
    region) The region in which the RDB instance exists.
    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.
    ProjectId string
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    Region string
    region) The region in which the RDB instance exists.
    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.
    projectId String
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    region String
    region) The region in which the RDB instance exists.
    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.
    projectId string
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    region string
    region) The region in which the RDB instance exists.
    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.
    project_id str
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    region str
    region) The region in which the RDB instance exists.
    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.
    projectId String
    The ID of the project the RDB instance is in. Can be used to filter instances when using name.
    region String
    region) The region in which the RDB instance exists.

    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[]
    readReplicas GetDatabaseInstanceReadReplica[]
    settings {[key: string]: string}
    tags string[]
    userName string
    volumeSizeInGb number
    volumeType string
    instanceId string
    name string
    projectId string
    region 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>
    readReplicas List<Property Map>
    settings Map<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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    port Number
    The port of your load balancer service

    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    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. Only one of name and instance_id should be specified.
    Port int
    Port of the replica
    Ip string
    IP of the replica
    Name string
    The name of the RDB instance. Only one of name and instance_id should be specified.
    Port int
    Port of the replica
    ip String
    IP of the replica
    name String
    The name of the RDB instance. Only one of name and instance_id should be specified.
    port Integer
    Port of the replica
    ip string
    IP of the replica
    name string
    The name of the RDB instance. Only one of name and instance_id should be specified.
    port number
    Port of the replica
    ip str
    IP of the replica
    name str
    The name of the RDB instance. Only one of name and instance_id should be specified.
    port int
    Port of the replica
    ip String
    IP of the replica
    name String
    The name of the RDB instance. Only one of name and instance_id should be specified.
    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 logo
    Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse