Google Cloud (GCP) Classic
getDatabaseInstance
Use this data source to get information about a Cloud SQL instance.
Example Usage
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var qa = Output.Create(Gcp.Sql.GetDatabaseInstance.InvokeAsync(new Gcp.Sql.GetDatabaseInstanceArgs
{
Name = "test-sql-instance",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/sql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sql.LookupDatabaseInstance(ctx, &sql.LookupDatabaseInstanceArgs{
Name: "test-sql-instance",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var qa = Output.of(SqlFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
.name("test-sql-instance")
.build()));
}
}
import pulumi
import pulumi_gcp as gcp
qa = gcp.sql.get_database_instance(name="test-sql-instance")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const qa = pulumi.output(gcp.sql.getDatabaseInstance({
name: "test-sql-instance",
}));
variables:
qa:
Fn::Invoke:
Function: gcp:sql:getDatabaseInstance
Arguments:
name: test-sql-instance
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(name: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(name: Optional[pulumi.Input[str]] = None,
project: 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: gcp:sql/getDatabaseInstance:getDatabaseInstance
Arguments:
# Arguments dictionary
The following arguments are supported:
getDatabaseInstance Result
The following output properties are available:
- Clones
List<Get
Database Instance Clone> - Connection
Name string - Database
Version string - Deletion
Protection bool - Encryption
Key stringName - First
Ip stringAddress - Id string
The provider-assigned unique ID for this managed resource.
- Ip
Addresses List<GetDatabase Instance Ip Address> - Master
Instance stringName - Name string
- Private
Ip stringAddress - Public
Ip stringAddress - Region string
- Replica
Configurations List<GetDatabase Instance Replica Configuration> - Restore
Backup List<GetContexts Database Instance Restore Backup Context> - Root
Password string - Self
Link string - Server
Ca List<GetCerts Database Instance Server Ca Cert> - Service
Account stringEmail Address - Settings
List<Get
Database Instance Setting> - Project string
- Clones
[]Get
Database Instance Clone - Connection
Name string - Database
Version string - Deletion
Protection bool - Encryption
Key stringName - First
Ip stringAddress - Id string
The provider-assigned unique ID for this managed resource.
- Ip
Addresses []GetDatabase Instance Ip Address - Master
Instance stringName - Name string
- Private
Ip stringAddress - Public
Ip stringAddress - Region string
- Replica
Configurations []GetDatabase Instance Replica Configuration - Restore
Backup []GetContexts Database Instance Restore Backup Context - Root
Password string - Self
Link string - Server
Ca []GetCerts Database Instance Server Ca Cert - Service
Account stringEmail Address - Settings
[]Get
Database Instance Setting - Project string
- clones
List<Get
Database Instance Clone> - connection
Name String - database
Version String - deletion
Protection Boolean - encryption
Key StringName - first
Ip StringAddress - id String
The provider-assigned unique ID for this managed resource.
- ip
Addresses List<GetDatabase Instance Ip Address> - master
Instance StringName - name String
- private
Ip StringAddress - public
Ip StringAddress - region String
- replica
Configurations List<GetDatabase Instance Replica Configuration> - restore
Backup List<GetContexts Database Instance Restore Backup Context> - root
Password String - self
Link String - server
Ca List<GetCerts Database Instance Server Ca Cert> - service
Account StringEmail Address - settings
List<Get
Database Instance Setting> - project String
- clones
Get
Database Instance Clone[] - connection
Name string - database
Version string - deletion
Protection boolean - encryption
Key stringName - first
Ip stringAddress - id string
The provider-assigned unique ID for this managed resource.
- ip
Addresses GetDatabase Instance Ip Address[] - master
Instance stringName - name string
- private
Ip stringAddress - public
Ip stringAddress - region string
- replica
Configurations GetDatabase Instance Replica Configuration[] - restore
Backup GetContexts Database Instance Restore Backup Context[] - root
Password string - self
Link string - server
Ca GetCerts Database Instance Server Ca Cert[] - service
Account stringEmail Address - settings
Get
Database Instance Setting[] - project string
- clones
Sequence[Get
Database Instance Clone] - connection_
name str - database_
version str - deletion_
protection bool - encryption_
key_ strname - first_
ip_ straddress - id str
The provider-assigned unique ID for this managed resource.
- ip_
addresses Sequence[GetDatabase Instance Ip Address] - master_
instance_ strname - name str
- private_
ip_ straddress - public_
ip_ straddress - region str
- replica_
configurations Sequence[GetDatabase Instance Replica Configuration] - restore_
backup_ Sequence[Getcontexts Database Instance Restore Backup Context] - root_
password str - self_
link str - server_
ca_ Sequence[Getcerts Database Instance Server Ca Cert] - service_
account_ stremail_ address - settings
Sequence[Get
Database Instance Setting] - project str
- clones List<Property Map>
- connection
Name String - database
Version String - deletion
Protection Boolean - encryption
Key StringName - first
Ip StringAddress - id String
The provider-assigned unique ID for this managed resource.
- ip
Addresses List<Property Map> - master
Instance StringName - name String
- private
Ip StringAddress - public
Ip StringAddress - region String
- replica
Configurations List<Property Map> - restore
Backup List<Property Map>Contexts - root
Password String - self
Link String - server
Ca List<Property Map>Certs - service
Account StringEmail Address - settings List<Property Map>
- project String
Supporting Types
GetDatabaseInstanceClone
- Allocated
Ip stringRange - Point
In stringTime - Source
Instance stringName
- Allocated
Ip stringRange - Point
In stringTime - Source
Instance stringName
- allocated
Ip StringRange - point
In StringTime - source
Instance StringName
- allocated
Ip stringRange - point
In stringTime - source
Instance stringName
- allocated
Ip StringRange - point
In StringTime - source
Instance StringName
GetDatabaseInstanceIpAddress
- Ip
Address string - Time
To stringRetire - Type string
- Ip
Address string - Time
To stringRetire - Type string
- ip
Address String - time
To StringRetire - type String
- ip
Address string - time
To stringRetire - type string
- ip_
address str - time_
to_ strretire - type str
- ip
Address String - time
To StringRetire - type String
GetDatabaseInstanceReplicaConfiguration
- Ca
Certificate string - Client
Certificate string - Client
Key string - Connect
Retry intInterval - Dump
File stringPath - Failover
Target bool - Master
Heartbeat intPeriod - Password string
- Ssl
Cipher string - Username string
- Verify
Server boolCertificate
- Ca
Certificate string - Client
Certificate string - Client
Key string - Connect
Retry intInterval - Dump
File stringPath - Failover
Target bool - Master
Heartbeat intPeriod - Password string
- Ssl
Cipher string - Username string
- Verify
Server boolCertificate
- ca
Certificate String - client
Certificate String - client
Key String - connect
Retry IntegerInterval - dump
File StringPath - failover
Target Boolean - master
Heartbeat IntegerPeriod - password String
- ssl
Cipher String - username String
- verify
Server BooleanCertificate
- ca
Certificate string - client
Certificate string - client
Key string - connect
Retry numberInterval - dump
File stringPath - failover
Target boolean - master
Heartbeat numberPeriod - password string
- ssl
Cipher string - username string
- verify
Server booleanCertificate
- ca_
certificate str - client_
certificate str - client_
key str - connect_
retry_ intinterval - dump_
file_ strpath - failover_
target bool - master_
heartbeat_ intperiod - password str
- ssl_
cipher str - username str
- verify_
server_ boolcertificate
- ca
Certificate String - client
Certificate String - client
Key String - connect
Retry NumberInterval - dump
File StringPath - failover
Target Boolean - master
Heartbeat NumberPeriod - password String
- ssl
Cipher String - username String
- verify
Server BooleanCertificate
GetDatabaseInstanceRestoreBackupContext
- Backup
Run intId - Instance
Id string - Project string
The ID of the project in which the resource belongs.
- Backup
Run intId - Instance
Id string - Project string
The ID of the project in which the resource belongs.
- backup
Run IntegerId - instance
Id String - project String
The ID of the project in which the resource belongs.
- backup
Run numberId - instance
Id string - project string
The ID of the project in which the resource belongs.
- backup_
run_ intid - instance_
id str - project str
The ID of the project in which the resource belongs.
- backup
Run NumberId - instance
Id String - project String
The ID of the project in which the resource belongs.
GetDatabaseInstanceServerCaCert
- Cert string
- Common
Name string - Create
Time string - Expiration
Time string - Sha1Fingerprint string
- Cert string
- Common
Name string - Create
Time string - Expiration
Time string - Sha1Fingerprint string
- cert String
- common
Name String - create
Time String - expiration
Time String - sha1Fingerprint String
- cert string
- common
Name string - create
Time string - expiration
Time string - sha1Fingerprint string
- cert str
- common_
name str - create_
time str - expiration_
time str - sha1_
fingerprint str
- cert String
- common
Name String - create
Time String - expiration
Time String - sha1Fingerprint String
GetDatabaseInstanceSetting
- Activation
Policy string - Active
Directory List<GetConfigs Database Instance Setting Active Directory Config> - Availability
Type string - Backup
Configurations List<GetDatabase Instance Setting Backup Configuration> - Collation string
- Database
Flags List<GetDatabase Instance Setting Database Flag> - Disk
Autoresize bool - Disk
Autoresize intLimit - Disk
Size int - Disk
Type string - Insights
Configs List<GetDatabase Instance Setting Insights Config> - Ip
Configurations List<GetDatabase Instance Setting Ip Configuration> - Location
Preferences List<GetDatabase Instance Setting Location Preference> - Maintenance
Windows List<GetDatabase Instance Setting Maintenance Window> - Pricing
Plan string - Sql
Server List<GetAudit Configs Database Instance Setting Sql Server Audit Config> - Tier string
- User
Labels Dictionary<string, string> - Version int
- Activation
Policy string - Active
Directory []GetConfigs Database Instance Setting Active Directory Config - Availability
Type string - Backup
Configurations []GetDatabase Instance Setting Backup Configuration - Collation string
- Database
Flags []GetDatabase Instance Setting Database Flag - Disk
Autoresize bool - Disk
Autoresize intLimit - Disk
Size int - Disk
Type string - Insights
Configs []GetDatabase Instance Setting Insights Config - Ip
Configurations []GetDatabase Instance Setting Ip Configuration - Location
Preferences []GetDatabase Instance Setting Location Preference - Maintenance
Windows []GetDatabase Instance Setting Maintenance Window - Pricing
Plan string - Sql
Server []GetAudit Configs Database Instance Setting Sql Server Audit Config - Tier string
- User
Labels map[string]string - Version int
- activation
Policy String - active
Directory List<GetConfigs Database Instance Setting Active Directory Config> - availability
Type String - backup
Configurations List<GetDatabase Instance Setting Backup Configuration> - collation String
- database
Flags List<GetDatabase Instance Setting Database Flag> - disk
Autoresize Boolean - disk
Autoresize IntegerLimit - disk
Size Integer - disk
Type String - insights
Configs List<GetDatabase Instance Setting Insights Config> - ip
Configurations List<GetDatabase Instance Setting Ip Configuration> - location
Preferences List<GetDatabase Instance Setting Location Preference> - maintenance
Windows List<GetDatabase Instance Setting Maintenance Window> - pricing
Plan String - sql
Server List<GetAudit Configs Database Instance Setting Sql Server Audit Config> - tier String
- user
Labels Map<String,String> - version Integer
- activation
Policy string - active
Directory GetConfigs Database Instance Setting Active Directory Config[] - availability
Type string - backup
Configurations GetDatabase Instance Setting Backup Configuration[] - collation string
- database
Flags GetDatabase Instance Setting Database Flag[] - disk
Autoresize boolean - disk
Autoresize numberLimit - disk
Size number - disk
Type string - insights
Configs GetDatabase Instance Setting Insights Config[] - ip
Configurations GetDatabase Instance Setting Ip Configuration[] - location
Preferences GetDatabase Instance Setting Location Preference[] - maintenance
Windows GetDatabase Instance Setting Maintenance Window[] - pricing
Plan string - sql
Server GetAudit Configs Database Instance Setting Sql Server Audit Config[] - tier string
- user
Labels {[key: string]: string} - version number
- activation_
policy str - active_
directory_ Sequence[Getconfigs Database Instance Setting Active Directory Config] - availability_
type str - backup_
configurations Sequence[GetDatabase Instance Setting Backup Configuration] - collation str
- database_
flags Sequence[GetDatabase Instance Setting Database Flag] - disk_
autoresize bool - disk_
autoresize_ intlimit - disk_
size int - disk_
type str - insights_
configs Sequence[GetDatabase Instance Setting Insights Config] - ip_
configurations Sequence[GetDatabase Instance Setting Ip Configuration] - location_
preferences Sequence[GetDatabase Instance Setting Location Preference] - maintenance_
windows Sequence[GetDatabase Instance Setting Maintenance Window] - pricing_
plan str - sql_
server_ Sequence[Getaudit_ configs Database Instance Setting Sql Server Audit Config] - tier str
- user_
labels Mapping[str, str] - version int
- activation
Policy String - active
Directory List<Property Map>Configs - availability
Type String - backup
Configurations List<Property Map> - collation String
- database
Flags List<Property Map> - disk
Autoresize Boolean - disk
Autoresize NumberLimit - disk
Size Number - disk
Type String - insights
Configs List<Property Map> - ip
Configurations List<Property Map> - location
Preferences List<Property Map> - maintenance
Windows List<Property Map> - pricing
Plan String - sql
Server List<Property Map>Audit Configs - tier String
- user
Labels Map<String> - version Number
GetDatabaseInstanceSettingActiveDirectoryConfig
- Domain string
- Domain string
- domain String
- domain string
- domain str
- domain String
GetDatabaseInstanceSettingBackupConfiguration
- backup
Retention List<Property Map>Settings - binary
Log BooleanEnabled - enabled Boolean
- location String
- point
In BooleanTime Recovery Enabled - start
Time String - transaction
Log NumberRetention Days
GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting
- Retained
Backups int - Retention
Unit string
- Retained
Backups int - Retention
Unit string
- retained
Backups Integer - retention
Unit String
- retained
Backups number - retention
Unit string
- retained_
backups int - retention_
unit str
- retained
Backups Number - retention
Unit String
GetDatabaseInstanceSettingDatabaseFlag
GetDatabaseInstanceSettingInsightsConfig
- Query
Insights boolEnabled - Query
String intLength - bool
- Record
Client boolAddress
- Query
Insights boolEnabled - Query
String intLength - bool
- Record
Client boolAddress
- query
Insights BooleanEnabled - query
String IntegerLength - Boolean
- record
Client BooleanAddress
- query
Insights booleanEnabled - query
String numberLength - boolean
- record
Client booleanAddress
- query_
insights_ boolenabled - query_
string_ intlength - bool
- record_
client_ booladdress
- query
Insights BooleanEnabled - query
String NumberLength - Boolean
- record
Client BooleanAddress
GetDatabaseInstanceSettingIpConfiguration
- allocated
Ip StringRange - List<Get
Database Instance Setting Ip Configuration Authorized Network> - ipv4Enabled Boolean
- private
Network String - require
Ssl Boolean
- allocated
Ip stringRange - Get
Database Instance Setting Ip Configuration Authorized Network[] - ipv4Enabled boolean
- private
Network string - require
Ssl boolean
- allocated
Ip StringRange - List<Property Map>
- ipv4Enabled Boolean
- private
Network String - require
Ssl Boolean
GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork
- Expiration
Time string - Name string
The name of the instance.
- Value string
- Expiration
Time string - Name string
The name of the instance.
- Value string
- expiration
Time String - name String
The name of the instance.
- value String
- expiration
Time string - name string
The name of the instance.
- value string
- expiration_
time str - name str
The name of the instance.
- value str
- expiration
Time String - name String
The name of the instance.
- value String
GetDatabaseInstanceSettingLocationPreference
- Follow
Gae stringApplication - Secondary
Zone string - Zone string
- Follow
Gae stringApplication - Secondary
Zone string - Zone string
- follow
Gae StringApplication - secondary
Zone String - zone String
- follow
Gae stringApplication - secondary
Zone string - zone string
- follow_
gae_ strapplication - secondary_
zone str - zone str
- follow
Gae StringApplication - secondary
Zone String - zone String
GetDatabaseInstanceSettingMaintenanceWindow
- Day int
- Hour int
- Update
Track string
- Day int
- Hour int
- Update
Track string
- day Integer
- hour Integer
- update
Track String
- day number
- hour number
- update
Track string
- day int
- hour int
- update_
track str
- day Number
- hour Number
- update
Track String
GetDatabaseInstanceSettingSqlServerAuditConfig
- Bucket string
- Retention
Interval string - Upload
Interval string
- Bucket string
- Retention
Interval string - Upload
Interval string
- bucket String
- retention
Interval String - upload
Interval String
- bucket string
- retention
Interval string - upload
Interval string
- bucket str
- retention_
interval str - upload_
interval str
- bucket String
- retention
Interval String - upload
Interval String
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.