Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Google Native

v0.9.0 published on Wednesday, Nov 24, 2021 by Pulumi

getInstance

Retrieves a resource containing information about a Cloud SQL instance.

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: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance: Optional[pulumi.Input[str]] = None,
                 project: 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)
}

The following arguments are supported:

Instance string
Project string
Instance string
Project string
instance string
project string

getInstance Result

The following output properties are available:

BackendType string
The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
ConnectionName string
Connection name of the Cloud SQL instance used in connection strings.
CreateTime string
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
CurrentDiskSize string
The current disk usage of the instance in bytes. This property has been deprecated. Use the “cloudsql.googleapis.com/database/disk/bytes_used” metric in Cloud Monitoring API instead. Please see this announcement for details.
DatabaseInstalledVersion string
The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50
DatabaseVersion string
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
DiskEncryptionConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.DiskEncryptionConfigurationResponse
Disk encryption configuration specific to an instance.
DiskEncryptionStatus Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.DiskEncryptionStatusResponse
Disk encryption status specific to an instance.
FailoverReplica Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.InstanceFailoverReplicaResponse
The name and status of the failover replica.
GceZone string
The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
InstanceType string
The instance type.
IpAddresses List<Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.IpMappingResponse>
The assigned IP addresses for the instance.
Kind string
This is always sql#instance.
MasterInstanceName string
The name of the instance which will act as primary in the replication setup.
MaxDiskSize string
The maximum disk size of the instance in bytes.
Name string
Name of the Cloud SQL instance. This does not include the project ID.
OnPremisesConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.OnPremisesConfigurationResponse
Configuration specific to on-premises instances.
OutOfDiskReport Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.SqlOutOfDiskReportResponse
This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
Project string
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
Region string
The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
ReplicaConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.ReplicaConfigurationResponse
Configuration specific to failover replicas and read replicas.
ReplicaNames List<string>
The replicas of the instance.
RootPassword string
Initial root password. Use only on creation.
SatisfiesPzs bool
The status indicating if instance satisfiesPzs. Reserved for future use.
ScheduledMaintenance Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.SqlScheduledMaintenanceResponse
The start time of any upcoming scheduled maintenance for this instance.
SecondaryGceZone string
The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
SelfLink string
The URI of this resource.
ServerCaCert Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.SslCertResponse
SSL configuration.
ServiceAccountEmailAddress string
The service account email address assigned to the instance. This property is read-only.
Settings Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.SettingsResponse
The user settings.
State string
The current serving state of the Cloud SQL instance.
SuspensionReason List<string>
If the instance state is SUSPENDED, the reason for the suspension.
BackendType string
The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
ConnectionName string
Connection name of the Cloud SQL instance used in connection strings.
CreateTime string
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
CurrentDiskSize string
The current disk usage of the instance in bytes. This property has been deprecated. Use the “cloudsql.googleapis.com/database/disk/bytes_used” metric in Cloud Monitoring API instead. Please see this announcement for details.
DatabaseInstalledVersion string
The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50
DatabaseVersion string
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
DiskEncryptionConfiguration DiskEncryptionConfigurationResponse
Disk encryption configuration specific to an instance.
DiskEncryptionStatus DiskEncryptionStatusResponse
Disk encryption status specific to an instance.
FailoverReplica InstanceFailoverReplicaResponse
The name and status of the failover replica.
GceZone string
The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
InstanceType string
The instance type.
IpAddresses []IpMappingResponse
The assigned IP addresses for the instance.
Kind string
This is always sql#instance.
MasterInstanceName string
The name of the instance which will act as primary in the replication setup.
MaxDiskSize string
The maximum disk size of the instance in bytes.
Name string
Name of the Cloud SQL instance. This does not include the project ID.
OnPremisesConfiguration OnPremisesConfigurationResponse
Configuration specific to on-premises instances.
OutOfDiskReport SqlOutOfDiskReportResponse
This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
Project string
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
Region string
The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
ReplicaConfiguration ReplicaConfigurationResponse
Configuration specific to failover replicas and read replicas.
ReplicaNames []string
The replicas of the instance.
RootPassword string
Initial root password. Use only on creation.
SatisfiesPzs bool
The status indicating if instance satisfiesPzs. Reserved for future use.
ScheduledMaintenance SqlScheduledMaintenanceResponse
The start time of any upcoming scheduled maintenance for this instance.
SecondaryGceZone string
The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
SelfLink string
The URI of this resource.
ServerCaCert SslCertResponse
SSL configuration.
ServiceAccountEmailAddress string
The service account email address assigned to the instance. This property is read-only.
Settings SettingsResponse
The user settings.
State string
The current serving state of the Cloud SQL instance.
SuspensionReason []string
If the instance state is SUSPENDED, the reason for the suspension.
backendType string
The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
connectionName string
Connection name of the Cloud SQL instance used in connection strings.
createTime string
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
currentDiskSize string
The current disk usage of the instance in bytes. This property has been deprecated. Use the “cloudsql.googleapis.com/database/disk/bytes_used” metric in Cloud Monitoring API instead. Please see this announcement for details.
databaseInstalledVersion string
The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50
databaseVersion string
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
diskEncryptionConfiguration DiskEncryptionConfigurationResponse
Disk encryption configuration specific to an instance.
diskEncryptionStatus DiskEncryptionStatusResponse
Disk encryption status specific to an instance.
failoverReplica InstanceFailoverReplicaResponse
The name and status of the failover replica.
gceZone string
The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
instanceType string
The instance type.
ipAddresses IpMappingResponse[]
The assigned IP addresses for the instance.
kind string
This is always sql#instance.
masterInstanceName string
The name of the instance which will act as primary in the replication setup.
maxDiskSize string
The maximum disk size of the instance in bytes.
name string
Name of the Cloud SQL instance. This does not include the project ID.
onPremisesConfiguration OnPremisesConfigurationResponse
Configuration specific to on-premises instances.
outOfDiskReport SqlOutOfDiskReportResponse
This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
project string
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
region string
The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
replicaConfiguration ReplicaConfigurationResponse
Configuration specific to failover replicas and read replicas.
replicaNames string[]
The replicas of the instance.
rootPassword string
Initial root password. Use only on creation.
satisfiesPzs boolean
The status indicating if instance satisfiesPzs. Reserved for future use.
scheduledMaintenance SqlScheduledMaintenanceResponse
The start time of any upcoming scheduled maintenance for this instance.
secondaryGceZone string
The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
selfLink string
The URI of this resource.
serverCaCert SslCertResponse
SSL configuration.
serviceAccountEmailAddress string
The service account email address assigned to the instance. This property is read-only.
settings SettingsResponse
The user settings.
state string
The current serving state of the Cloud SQL instance.
suspensionReason string[]
If the instance state is SUSPENDED, the reason for the suspension.
backend_type str
The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
connection_name str
Connection name of the Cloud SQL instance used in connection strings.
create_time str
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
current_disk_size str
The current disk usage of the instance in bytes. This property has been deprecated. Use the “cloudsql.googleapis.com/database/disk/bytes_used” metric in Cloud Monitoring API instead. Please see this announcement for details.
database_installed_version str
The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50
database_version str
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
disk_encryption_configuration DiskEncryptionConfigurationResponse
Disk encryption configuration specific to an instance.
disk_encryption_status DiskEncryptionStatusResponse
Disk encryption status specific to an instance.
failover_replica InstanceFailoverReplicaResponse
The name and status of the failover replica.
gce_zone str
The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
instance_type str
The instance type.
ip_addresses Sequence[IpMappingResponse]
The assigned IP addresses for the instance.
kind str
This is always sql#instance.
master_instance_name str
The name of the instance which will act as primary in the replication setup.
max_disk_size str
The maximum disk size of the instance in bytes.
name str
Name of the Cloud SQL instance. This does not include the project ID.
on_premises_configuration OnPremisesConfigurationResponse
Configuration specific to on-premises instances.
out_of_disk_report SqlOutOfDiskReportResponse
This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
project str
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
region str
The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
replica_configuration ReplicaConfigurationResponse
Configuration specific to failover replicas and read replicas.
replica_names Sequence[str]
The replicas of the instance.
root_password str
Initial root password. Use only on creation.
satisfies_pzs bool
The status indicating if instance satisfiesPzs. Reserved for future use.
scheduled_maintenance SqlScheduledMaintenanceResponse
The start time of any upcoming scheduled maintenance for this instance.
secondary_gce_zone str
The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
self_link str
The URI of this resource.
server_ca_cert SslCertResponse
SSL configuration.
service_account_email_address str
The service account email address assigned to the instance. This property is read-only.
settings SettingsResponse
The user settings.
state str
The current serving state of the Cloud SQL instance.
suspension_reason Sequence[str]
If the instance state is SUSPENDED, the reason for the suspension.

Supporting Types

AclEntryResponse

ExpirationTime string
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Kind string
This is always sql#aclEntry.
Name string
Optional. A label to identify this entry.
Value string
The allowlisted value for the access control list.
ExpirationTime string
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Kind string
This is always sql#aclEntry.
Name string
Optional. A label to identify this entry.
Value string
The allowlisted value for the access control list.
expirationTime string
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
kind string
This is always sql#aclEntry.
name string
Optional. A label to identify this entry.
value string
The allowlisted value for the access control list.
expiration_time str
The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
kind str
This is always sql#aclEntry.
name str
Optional. A label to identify this entry.
value str
The allowlisted value for the access control list.

BackupConfigurationResponse

BackupRetentionSettings Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.BackupRetentionSettingsResponse
Backup retention settings.
BinaryLogEnabled bool
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
Enabled bool
Whether this configuration is enabled.
Kind string
This is always sql#backupConfiguration.
Location string
Location of the backup
PointInTimeRecoveryEnabled bool
(Postgres only) Whether point in time recovery is enabled.
ReplicationLogArchivingEnabled bool
Reserved for future use.
StartTime string
Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
TransactionLogRetentionDays int
The number of days of transaction logs we retain for point in time restore, from 1-7.
BackupRetentionSettings BackupRetentionSettingsResponse
Backup retention settings.
BinaryLogEnabled bool
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
Enabled bool
Whether this configuration is enabled.
Kind string
This is always sql#backupConfiguration.
Location string
Location of the backup
PointInTimeRecoveryEnabled bool
(Postgres only) Whether point in time recovery is enabled.
ReplicationLogArchivingEnabled bool
Reserved for future use.
StartTime string
Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
TransactionLogRetentionDays int
The number of days of transaction logs we retain for point in time restore, from 1-7.
backupRetentionSettings BackupRetentionSettingsResponse
Backup retention settings.
binaryLogEnabled boolean
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
enabled boolean
Whether this configuration is enabled.
kind string
This is always sql#backupConfiguration.
location string
Location of the backup
pointInTimeRecoveryEnabled boolean
(Postgres only) Whether point in time recovery is enabled.
replicationLogArchivingEnabled boolean
Reserved for future use.
startTime string
Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
transactionLogRetentionDays number
The number of days of transaction logs we retain for point in time restore, from 1-7.
backup_retention_settings BackupRetentionSettingsResponse
Backup retention settings.
binary_log_enabled bool
(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
enabled bool
Whether this configuration is enabled.
kind str
This is always sql#backupConfiguration.
location str
Location of the backup
point_in_time_recovery_enabled bool
(Postgres only) Whether point in time recovery is enabled.
replication_log_archiving_enabled bool
Reserved for future use.
start_time str
Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
transaction_log_retention_days int
The number of days of transaction logs we retain for point in time restore, from 1-7.

BackupRetentionSettingsResponse

RetainedBackups int
Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is ‘COUNT’, we will retain this many backups.
RetentionUnit string
The unit that ‘retained_backups’ represents.
RetainedBackups int
Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is ‘COUNT’, we will retain this many backups.
RetentionUnit string
The unit that ‘retained_backups’ represents.
retainedBackups number
Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is ‘COUNT’, we will retain this many backups.
retentionUnit string
The unit that ‘retained_backups’ represents.
retained_backups int
Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is ‘COUNT’, we will retain this many backups.
retention_unit str
The unit that ‘retained_backups’ represents.

DatabaseFlagsResponse

Name string
The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
Value string
The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn’t take a value.
Name string
The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
Value string
The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn’t take a value.
name string
The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
value string
The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn’t take a value.
name str
The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
value str
The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn’t take a value.

DenyMaintenancePeriodResponse

EndDate string
“deny maintenance period” end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
StartDate string
“deny maintenance period” start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
Time string
Time in UTC when the “deny maintenance period” starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
EndDate string
“deny maintenance period” end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
StartDate string
“deny maintenance period” start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
Time string
Time in UTC when the “deny maintenance period” starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
endDate string
“deny maintenance period” end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
startDate string
“deny maintenance period” start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time string
Time in UTC when the “deny maintenance period” starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
end_date str
“deny maintenance period” end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
start_date str
“deny maintenance period” start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time str
Time in UTC when the “deny maintenance period” starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

DiskEncryptionConfigurationResponse

Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
kind string
This is always sql#diskEncryptionConfiguration.
kmsKeyName string
Resource name of KMS key for disk encryption
kind str
This is always sql#diskEncryptionConfiguration.
kms_key_name str
Resource name of KMS key for disk encryption

DiskEncryptionStatusResponse

Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind string
This is always sql#diskEncryptionStatus.
kmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind str
This is always sql#diskEncryptionStatus.
kms_key_version_name str
KMS key version used to encrypt the Cloud SQL instance resource

InsightsConfigResponse

QueryInsightsEnabled bool
Whether Query Insights feature is enabled.
QueryPlansPerMinute int
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
QueryStringLength int
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
RecordApplicationTags bool
Whether Query Insights will record application tags from query when enabled.
RecordClientAddress bool
Whether Query Insights will record client address when enabled.
QueryInsightsEnabled bool
Whether Query Insights feature is enabled.
QueryPlansPerMinute int
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
QueryStringLength int
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
RecordApplicationTags bool
Whether Query Insights will record application tags from query when enabled.
RecordClientAddress bool
Whether Query Insights will record client address when enabled.
queryInsightsEnabled boolean
Whether Query Insights feature is enabled.
queryPlansPerMinute number
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
queryStringLength number
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
recordApplicationTags boolean
Whether Query Insights will record application tags from query when enabled.
recordClientAddress boolean
Whether Query Insights will record client address when enabled.
query_insights_enabled bool
Whether Query Insights feature is enabled.
query_plans_per_minute int
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
query_string_length int
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
record_application_tags bool
Whether Query Insights will record application tags from query when enabled.
record_client_address bool
Whether Query Insights will record client address when enabled.

InstanceFailoverReplicaResponse

Available bool
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
Name string
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn’t include the project ID.
Available bool
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
Name string
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn’t include the project ID.
available boolean
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
name string
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn’t include the project ID.
available bool
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
name str
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn’t include the project ID.

InstanceReferenceResponse

Name string
The name of the Cloud SQL instance being referenced. This does not include the project ID.
Project string
The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.
Region string
The region of the Cloud SQL instance being referenced.
Name string
The name of the Cloud SQL instance being referenced. This does not include the project ID.
Project string
The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.
Region string
The region of the Cloud SQL instance being referenced.
name string
The name of the Cloud SQL instance being referenced. This does not include the project ID.
project string
The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.
region string
The region of the Cloud SQL instance being referenced.
name str
The name of the Cloud SQL instance being referenced. This does not include the project ID.
project str
The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.
region str
The region of the Cloud SQL instance being referenced.

IpConfigurationResponse

AllocatedIpRange string
The name of the allocated ip range for the private ip CloudSQL instance. For example: “google-managed-services-default”. If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
AuthorizedNetworks List<Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.AclEntryResponse>
The list of external networks that are allowed to connect to the instance using the IP. In ‘CIDR’ notation, also known as ‘slash’ notation (for example: 192.168.100.0/24).
Ipv4Enabled bool
Whether the instance is assigned a public IP address or not.
PrivateNetwork string
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
RequireSsl bool
Whether SSL connections over IP are enforced or not.
AllocatedIpRange string
The name of the allocated ip range for the private ip CloudSQL instance. For example: “google-managed-services-default”. If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
AuthorizedNetworks []AclEntryResponse
The list of external networks that are allowed to connect to the instance using the IP. In ‘CIDR’ notation, also known as ‘slash’ notation (for example: 192.168.100.0/24).
Ipv4Enabled bool
Whether the instance is assigned a public IP address or not.
PrivateNetwork string
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
RequireSsl bool
Whether SSL connections over IP are enforced or not.
allocatedIpRange string
The name of the allocated ip range for the private ip CloudSQL instance. For example: “google-managed-services-default”. If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorizedNetworks AclEntryResponse[]
The list of external networks that are allowed to connect to the instance using the IP. In ‘CIDR’ notation, also known as ‘slash’ notation (for example: 192.168.100.0/24).
ipv4Enabled boolean
Whether the instance is assigned a public IP address or not.
privateNetwork string
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
requireSsl boolean
Whether SSL connections over IP are enforced or not.
allocated_ip_range str
The name of the allocated ip range for the private ip CloudSQL instance. For example: “google-managed-services-default”. If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorized_networks Sequence[AclEntryResponse]
The list of external networks that are allowed to connect to the instance using the IP. In ‘CIDR’ notation, also known as ‘slash’ notation (for example: 192.168.100.0/24).
ipv4_enabled bool
Whether the instance is assigned a public IP address or not.
private_network str
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
require_ssl bool
Whether SSL connections over IP are enforced or not.

IpMappingResponse

IpAddress string
The IP address assigned.
TimeToRetire string
The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
Type string
The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
IpAddress string
The IP address assigned.
TimeToRetire string
The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
Type string
The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
ipAddress string
The IP address assigned.
timeToRetire string
The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
type string
The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
ip_address str
The IP address assigned.
time_to_retire str
The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
type str
The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.

LocationPreferenceResponse

FollowGaeApplication string
The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
Kind string
This is always sql#locationPreference.
SecondaryZone string
The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
Zone string
The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
FollowGaeApplication string
The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
Kind string
This is always sql#locationPreference.
SecondaryZone string
The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
Zone string
The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
followGaeApplication string
The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
kind string
This is always sql#locationPreference.
secondaryZone string
The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
zone string
The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
follow_gae_application str
The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
kind str
This is always sql#locationPreference.
secondary_zone str
The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
zone str
The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

MaintenanceWindowResponse

Day int
day of week (1-7), starting on Monday.
Hour int
hour of day - 0 to 23.
Kind string
This is always sql#maintenanceWindow.
UpdateTrack string
Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.
Day int
day of week (1-7), starting on Monday.
Hour int
hour of day - 0 to 23.
Kind string
This is always sql#maintenanceWindow.
UpdateTrack string
Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.
day number
day of week (1-7), starting on Monday.
hour number
hour of day - 0 to 23.
kind string
This is always sql#maintenanceWindow.
updateTrack string
Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.
day int
day of week (1-7), starting on Monday.
hour int
hour of day - 0 to 23.
kind str
This is always sql#maintenanceWindow.
update_track str
Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.

MySqlReplicaConfigurationResponse

CaCertificate string
PEM representation of the trusted CA’s x509 certificate.
ClientCertificate string
PEM representation of the replica’s x509 certificate.
ClientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
ConnectRetryInterval int
Seconds to wait between connect retries. MySQL’s default is 60 seconds.
DumpFilePath string
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting –master-data to 1 when using mysqldump.
Kind string
This is always sql#mysqlReplicaConfiguration.
MasterHeartbeatPeriod string
Interval in milliseconds between replication heartbeats.
Password string
The password for the replication connection.
SslCipher string
A list of permissible ciphers to use for SSL encryption.
Username string
The username for the replication connection.
VerifyServerCertificate bool
Whether or not to check the primary instance’s Common Name value in the certificate that it sends during the SSL handshake.
CaCertificate string
PEM representation of the trusted CA’s x509 certificate.
ClientCertificate string
PEM representation of the replica’s x509 certificate.
ClientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
ConnectRetryInterval int
Seconds to wait between connect retries. MySQL’s default is 60 seconds.
DumpFilePath string
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting –master-data to 1 when using mysqldump.
Kind string
This is always sql#mysqlReplicaConfiguration.
MasterHeartbeatPeriod string
Interval in milliseconds between replication heartbeats.
Password string
The password for the replication connection.
SslCipher string
A list of permissible ciphers to use for SSL encryption.
Username string
The username for the replication connection.
VerifyServerCertificate bool
Whether or not to check the primary instance’s Common Name value in the certificate that it sends during the SSL handshake.
caCertificate string
PEM representation of the trusted CA’s x509 certificate.
clientCertificate string
PEM representation of the replica’s x509 certificate.
clientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
connectRetryInterval number
Seconds to wait between connect retries. MySQL’s default is 60 seconds.
dumpFilePath string
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting –master-data to 1 when using mysqldump.
kind string
This is always sql#mysqlReplicaConfiguration.
masterHeartbeatPeriod string
Interval in milliseconds between replication heartbeats.
password string
The password for the replication connection.
sslCipher string
A list of permissible ciphers to use for SSL encryption.
username string
The username for the replication connection.
verifyServerCertificate boolean
Whether or not to check the primary instance’s Common Name value in the certificate that it sends during the SSL handshake.
ca_certificate str
PEM representation of the trusted CA’s x509 certificate.
client_certificate str
PEM representation of the replica’s x509 certificate.
client_key str
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
connect_retry_interval int
Seconds to wait between connect retries. MySQL’s default is 60 seconds.
dump_file_path str
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting –master-data to 1 when using mysqldump.
kind str
This is always sql#mysqlReplicaConfiguration.
master_heartbeat_period str
Interval in milliseconds between replication heartbeats.
password str
The password for the replication connection.
ssl_cipher str
A list of permissible ciphers to use for SSL encryption.
username str
The username for the replication connection.
verify_server_certificate bool
Whether or not to check the primary instance’s Common Name value in the certificate that it sends during the SSL handshake.

OnPremisesConfigurationResponse

CaCertificate string
PEM representation of the trusted CA’s x509 certificate.
ClientCertificate string
PEM representation of the replica’s x509 certificate.
ClientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
DumpFilePath string
The dump file to create the Cloud SQL replica.
HostPort string
The host and port of the on-premises instance in host:port format
Kind string
This is always sql#onPremisesConfiguration.
Password string
The password for connecting to on-premises instance.
SourceInstance Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.InstanceReferenceResponse
The reference to Cloud SQL instance if the source is Cloud SQL.
Username string
The username for connecting to on-premises instance.
CaCertificate string
PEM representation of the trusted CA’s x509 certificate.
ClientCertificate string
PEM representation of the replica’s x509 certificate.
ClientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
DumpFilePath string
The dump file to create the Cloud SQL replica.
HostPort string
The host and port of the on-premises instance in host:port format
Kind string
This is always sql#onPremisesConfiguration.
Password string
The password for connecting to on-premises instance.
SourceInstance InstanceReferenceResponse
The reference to Cloud SQL instance if the source is Cloud SQL.
Username string
The username for connecting to on-premises instance.
caCertificate string
PEM representation of the trusted CA’s x509 certificate.
clientCertificate string
PEM representation of the replica’s x509 certificate.
clientKey string
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
dumpFilePath string
The dump file to create the Cloud SQL replica.
hostPort string
The host and port of the on-premises instance in host:port format
kind string
This is always sql#onPremisesConfiguration.
password string
The password for connecting to on-premises instance.
sourceInstance InstanceReferenceResponse
The reference to Cloud SQL instance if the source is Cloud SQL.
username string
The username for connecting to on-premises instance.
ca_certificate str
PEM representation of the trusted CA’s x509 certificate.
client_certificate str
PEM representation of the replica’s x509 certificate.
client_key str
PEM representation of the replica’s private key. The corresponsing public key is encoded in the client’s certificate.
dump_file_path str
The dump file to create the Cloud SQL replica.
host_port str
The host and port of the on-premises instance in host:port format
kind str
This is always sql#onPremisesConfiguration.
password str
The password for connecting to on-premises instance.
source_instance InstanceReferenceResponse
The reference to Cloud SQL instance if the source is Cloud SQL.
username str
The username for connecting to on-premises instance.

PasswordValidationPolicyResponse

Complexity string
The complexity of the password.
DisallowUsernameSubstring bool
Disallow username as a part of the password.
MinLength int
Minimum number of characters allowed.
PasswordChangeInterval string
Minimum interval after which the password can be changed.
ReuseInterval int
Number of previous passwords that cannot be reused.
Complexity string
The complexity of the password.
DisallowUsernameSubstring bool
Disallow username as a part of the password.
MinLength int
Minimum number of characters allowed.
PasswordChangeInterval string
Minimum interval after which the password can be changed.
ReuseInterval int
Number of previous passwords that cannot be reused.
complexity string
The complexity of the password.
disallowUsernameSubstring boolean
Disallow username as a part of the password.
minLength number
Minimum number of characters allowed.
passwordChangeInterval string
Minimum interval after which the password can be changed.
reuseInterval number
Number of previous passwords that cannot be reused.
complexity str
The complexity of the password.
disallow_username_substring bool
Disallow username as a part of the password.
min_length int
Minimum number of characters allowed.
password_change_interval str
Minimum interval after which the password can be changed.
reuse_interval int
Number of previous passwords that cannot be reused.

ReplicaConfigurationResponse

FailoverTarget bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
Kind string
This is always sql#replicaConfiguration.
MysqlReplicaConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.MySqlReplicaConfigurationResponse
MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
FailoverTarget bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
Kind string
This is always sql#replicaConfiguration.
MysqlReplicaConfiguration MySqlReplicaConfigurationResponse
MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
failoverTarget boolean
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
kind string
This is always sql#replicaConfiguration.
mysqlReplicaConfiguration MySqlReplicaConfigurationResponse
MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
failover_target bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
kind str
This is always sql#replicaConfiguration.
mysql_replica_configuration MySqlReplicaConfigurationResponse
MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

SettingsResponse

ActivationPolicy string
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
ActiveDirectoryConfig Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.SqlActiveDirectoryConfigResponse
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
AvailabilityType string
Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.
BackupConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.BackupConfigurationResponse
The daily backup configuration for the instance.
Collation string
The name of server Instance collation.
CrashSafeReplicationEnabled bool
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
DataDiskSizeGb string
The size of data disk, in GB. The data disk size minimum is 10GB.
DataDiskType string
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
DatabaseFlags List<Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.DatabaseFlagsResponse>
The database flags passed to the instance at startup.
DatabaseReplicationEnabled bool
Configuration specific to read replica instances. Indicates whether replication is enabled or not.
DenyMaintenancePeriods List<Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.DenyMaintenancePeriodResponse>
Deny maintenance periods
InsightsConfig Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.InsightsConfigResponse
Insights configuration, for now relevant only for Postgres.
IpConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.IpConfigurationResponse
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
Kind string
This is always sql#settings.
LocationPreference Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.LocationPreferenceResponse
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
MaintenanceWindow Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.MaintenanceWindowResponse
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
PasswordValidationPolicy Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.PasswordValidationPolicyResponse
The local user password validation policy of the instance.
PricingPlan string
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
SettingsVersion string
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
SqlServerAuditConfig Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.SqlServerAuditConfigResponse
SQL Server specific audit configuration.
StorageAutoResize bool
Configuration to increase storage size automatically. The default value is true.
StorageAutoResizeLimit string
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
Tier string
The tier (or machine type) for this instance, for example db-custom-1-3840.
UserLabels Dictionary<string, string>
User-provided labels, represented as a dictionary where each label is a single key value pair.
ActivationPolicy string
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
ActiveDirectoryConfig SqlActiveDirectoryConfigResponse
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
AvailabilityType string
Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.
BackupConfiguration BackupConfigurationResponse
The daily backup configuration for the instance.
Collation string
The name of server Instance collation.
CrashSafeReplicationEnabled bool
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
DataDiskSizeGb string
The size of data disk, in GB. The data disk size minimum is 10GB.
DataDiskType string
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
DatabaseFlags []DatabaseFlagsResponse
The database flags passed to the instance at startup.
DatabaseReplicationEnabled bool
Configuration specific to read replica instances. Indicates whether replication is enabled or not.
DenyMaintenancePeriods []DenyMaintenancePeriodResponse
Deny maintenance periods
InsightsConfig InsightsConfigResponse
Insights configuration, for now relevant only for Postgres.
IpConfiguration IpConfigurationResponse
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
Kind string
This is always sql#settings.
LocationPreference LocationPreferenceResponse
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
MaintenanceWindow MaintenanceWindowResponse
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
PasswordValidationPolicy PasswordValidationPolicyResponse
The local user password validation policy of the instance.
PricingPlan string
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
SettingsVersion string
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
SqlServerAuditConfig SqlServerAuditConfigResponse
SQL Server specific audit configuration.
StorageAutoResize bool
Configuration to increase storage size automatically. The default value is true.
StorageAutoResizeLimit string
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
Tier string
The tier (or machine type) for this instance, for example db-custom-1-3840.
UserLabels map[string]string
User-provided labels, represented as a dictionary where each label is a single key value pair.
activationPolicy string
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
activeDirectoryConfig SqlActiveDirectoryConfigResponse
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
availabilityType string
Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.
backupConfiguration BackupConfigurationResponse
The daily backup configuration for the instance.
collation string
The name of server Instance collation.
crashSafeReplicationEnabled boolean
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
dataDiskSizeGb string
The size of data disk, in GB. The data disk size minimum is 10GB.
dataDiskType string
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
databaseFlags DatabaseFlagsResponse[]
The database flags passed to the instance at startup.
databaseReplicationEnabled boolean
Configuration specific to read replica instances. Indicates whether replication is enabled or not.
denyMaintenancePeriods DenyMaintenancePeriodResponse[]
Deny maintenance periods
insightsConfig InsightsConfigResponse
Insights configuration, for now relevant only for Postgres.
ipConfiguration IpConfigurationResponse
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
kind string
This is always sql#settings.
locationPreference LocationPreferenceResponse
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
maintenanceWindow MaintenanceWindowResponse
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
passwordValidationPolicy PasswordValidationPolicyResponse
The local user password validation policy of the instance.
pricingPlan string
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
settingsVersion string
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
sqlServerAuditConfig SqlServerAuditConfigResponse
SQL Server specific audit configuration.
storageAutoResize boolean
Configuration to increase storage size automatically. The default value is true.
storageAutoResizeLimit string
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
tier string
The tier (or machine type) for this instance, for example db-custom-1-3840.
userLabels {[key: string]: string}
User-provided labels, represented as a dictionary where each label is a single key value pair.
activation_policy str
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
active_directory_config SqlActiveDirectoryConfigResponse
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
availability_type str
Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.
backup_configuration BackupConfigurationResponse
The daily backup configuration for the instance.
collation str
The name of server Instance collation.
crash_safe_replication_enabled bool
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
data_disk_size_gb str
The size of data disk, in GB. The data disk size minimum is 10GB.
data_disk_type str
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
database_flags Sequence[DatabaseFlagsResponse]
The database flags passed to the instance at startup.
database_replication_enabled bool
Configuration specific to read replica instances. Indicates whether replication is enabled or not.
deny_maintenance_periods Sequence[DenyMaintenancePeriodResponse]
Deny maintenance periods
insights_config InsightsConfigResponse
Insights configuration, for now relevant only for Postgres.
ip_configuration IpConfigurationResponse
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
kind str
This is always sql#settings.
location_preference LocationPreferenceResponse
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
maintenance_window MaintenanceWindowResponse
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
password_validation_policy PasswordValidationPolicyResponse
The local user password validation policy of the instance.
pricing_plan str
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
settings_version str
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
sql_server_audit_config SqlServerAuditConfigResponse
SQL Server specific audit configuration.
storage_auto_resize bool
Configuration to increase storage size automatically. The default value is true.
storage_auto_resize_limit str
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
tier str
The tier (or machine type) for this instance, for example db-custom-1-3840.
user_labels Mapping[str, str]
User-provided labels, represented as a dictionary where each label is a single key value pair.

SqlActiveDirectoryConfigResponse

Domain string
The name of the domain (e.g., mydomain.com).
Kind string
This is always sql#activeDirectoryConfig.
Domain string
The name of the domain (e.g., mydomain.com).
Kind string
This is always sql#activeDirectoryConfig.
domain string
The name of the domain (e.g., mydomain.com).
kind string
This is always sql#activeDirectoryConfig.
domain str
The name of the domain (e.g., mydomain.com).
kind str
This is always sql#activeDirectoryConfig.

SqlOutOfDiskReportResponse

SqlMinRecommendedIncreaseSizeGb int
The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:
SqlOutOfDiskState string
This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
SqlMinRecommendedIncreaseSizeGb int
The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:
SqlOutOfDiskState string
This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
sqlMinRecommendedIncreaseSizeGb number
The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:
sqlOutOfDiskState string
This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
sql_min_recommended_increase_size_gb int
The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:
sql_out_of_disk_state str
This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job

SqlScheduledMaintenanceResponse

CanDefer bool
CanReschedule bool
If the scheduled maintenance can be rescheduled.
ScheduleDeadlineTime string
Maintenance cannot be rescheduled to start beyond this deadline.
StartTime string
The start time of any upcoming scheduled maintenance for this instance.
CanDefer bool
CanReschedule bool
If the scheduled maintenance can be rescheduled.
ScheduleDeadlineTime string
Maintenance cannot be rescheduled to start beyond this deadline.
StartTime string
The start time of any upcoming scheduled maintenance for this instance.
canDefer boolean
canReschedule boolean
If the scheduled maintenance can be rescheduled.
scheduleDeadlineTime string
Maintenance cannot be rescheduled to start beyond this deadline.
startTime string
The start time of any upcoming scheduled maintenance for this instance.
can_defer bool
can_reschedule bool
If the scheduled maintenance can be rescheduled.
schedule_deadline_time str
Maintenance cannot be rescheduled to start beyond this deadline.
start_time str
The start time of any upcoming scheduled maintenance for this instance.

SqlServerAuditConfigResponse

Bucket string
The name of the destination bucket (e.g., gs://mybucket).
Kind string
This is always sql#sqlServerAuditConfig
Bucket string
The name of the destination bucket (e.g., gs://mybucket).
Kind string
This is always sql#sqlServerAuditConfig
bucket string
The name of the destination bucket (e.g., gs://mybucket).
kind string
This is always sql#sqlServerAuditConfig
bucket str
The name of the destination bucket (e.g., gs://mybucket).
kind str
This is always sql#sqlServerAuditConfig

SslCertResponse

Cert string
PEM representation.
CertSerialNumber string
Serial number, as extracted from the certificate.
CommonName string
User supplied name. Constrained to [a-zA-Z.-_ ]+.
CreateTime string
The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
ExpirationTime string
The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Instance string
Name of the database instance.
Kind string
This is always sql#sslCert.
SelfLink string
The URI of this resource.
Sha1Fingerprint string
Sha1 Fingerprint.
Cert string
PEM representation.
CertSerialNumber string
Serial number, as extracted from the certificate.
CommonName string
User supplied name. Constrained to [a-zA-Z.-_ ]+.
CreateTime string
The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
ExpirationTime string
The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Instance string
Name of the database instance.
Kind string
This is always sql#sslCert.
SelfLink string
The URI of this resource.
Sha1Fingerprint string
Sha1 Fingerprint.
cert string
PEM representation.
certSerialNumber string
Serial number, as extracted from the certificate.
commonName string
User supplied name. Constrained to [a-zA-Z.-_ ]+.
createTime string
The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
expirationTime string
The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
instance string
Name of the database instance.
kind string
This is always sql#sslCert.
selfLink string
The URI of this resource.
sha1Fingerprint string
Sha1 Fingerprint.
cert str
PEM representation.
cert_serial_number str
Serial number, as extracted from the certificate.
common_name str
User supplied name. Constrained to [a-zA-Z.-_ ]+.
create_time str
The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
expiration_time str
The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
instance str
Name of the database instance.
kind str
This is always sql#sslCert.
self_link str
The URI of this resource.
sha1_fingerprint str
Sha1 Fingerprint.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0