GetDatabaseInstancesInstance class
Constructors
-
GetDatabaseInstancesInstance({required Input<List<String>> availableMaintenanceVersions, required Input<String> backupdrBackup, required Input<List<GetDatabaseInstancesInstanceClone>> clones, required Input<String> connectionName, required Input<String> databaseVersion, required Input<String> deletionPolicy, required Input<bool> deletionProtection, required Input<String> dnsName, required Input<List<GetDatabaseInstancesInstanceDnsName>> dnsNames, required Input<String> encryptionKeyName, required Input<bool> enforceNewSqlNetworkArchitecture, required Input<String> finalBackupDescription, required Input<String> firstIpAddress, required Input<bool> includeReplicasForMajorVersionUpgrade, required Input<String> instanceType, required Input<List<GetDatabaseInstancesInstanceIpAddress>> ipAddresses, required Input<String> maintenanceVersion, required Input<String> masterInstanceName, required Input<String> name, required Input<int> nodeCount, required Input<List<GetDatabaseInstancesInstancePointInTimeRestoreContext>> pointInTimeRestoreContexts, required Input<String> privateIpAddress, required Input<String> project, required Input<String> pscServiceAttachmentLink, required Input<String> publicIpAddress, required Input<String> region, required Input<List<GetDatabaseInstancesInstanceReplicaConfiguration>> replicaConfigurations, required Input<List<String>> replicaNames, required Input<List<GetDatabaseInstancesInstanceReplicationCluster>> replicationClusters, required Input<List<GetDatabaseInstancesInstanceRestoreBackupContext>> restoreBackupContexts, required Input<String> rootPassword, required Input<String> rootPasswordWo, required Input<String> rootPasswordWoVersion, required Input<String> selfLink, required Input<List<GetDatabaseInstancesInstanceServerCaCert>> serverCaCerts, required Input<String> serviceAccountEmailAddress, required Input<List<GetDatabaseInstancesInstanceSetting>> settings, required Input<bool> switchTransactionLogsToCloudStorageEnabled})
-
Creates a new GetDatabaseInstancesInstance.
availableMaintenanceVersions Available Maintenance versions.
backupdrBackup The name of the BackupDR backup to restore from.
clones Configuration for creating a new instance as a clone of another instance.
connectionName The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
databaseVersion To filter out the Cloud SQL instances which are of the specified database version.
deletionPolicy Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE".
deletionProtection Used to block Terraform from deleting a SQL Instance. Defaults to true.
dnsName The instance-level dns name of the instance for PSC instances or public IP CAS instances.
dnsNames The list of DNS names used by this instance. Different connection types for an instance may have different DNS names. DNS names can apply to an individual instance or a cluster of instances.
encryptionKeyName Required.
enforceNewSqlNetworkArchitecture Whether to enforce the new SQL network architecture.
finalBackupDescription The description of final backup if instance enable create final backup during instance deletion.
firstIpAddress The first IPv4 address of any type assigned. This is to support accessing the first address in the list in a terraform output when the resource is configured with a count.
includeReplicasForMajorVersionUpgrade When this parameter is set to true, Cloud SQL instances can perform in-place major version upgrades of read replicas along with the primary instance when 'database_version' is updated. This is an input-only field that is not persisted in the API and only takes effect during a major version upgrade.
instanceType The type of the instance. See https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instances#SqlInstanceType for supported values.
ipAddresses Required.
maintenanceVersion Maintenance version.
masterInstanceName The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binaryLogEnabled set, as well as existing backups.
name The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week.
nodeCount For a read pool instance, the number of nodes in the read pool. For read pools with auto scaling enabled, this field is read only.
pointInTimeRestoreContexts Configuration for creating a new instance using point-in-time-restore from backupdr backup.
privateIpAddress IPv4 address assigned. This is a workaround for an issue fixed in Terraform 0.12 but also provides a convenient way to access an IP of a specific type without performing filtering in a Terraform config.
project The ID of the project in which the resources belong. If it is not provided, the provider project is used.
pscServiceAttachmentLink The link to service attachment of PSC instance.
publicIpAddress IPv4 address assigned. This is a workaround for an issue fixed in Terraform 0.12 but also provides a convenient way to access an IP of a specific type without performing filtering in a Terraform config.
region To filter out the Cloud SQL instances which are located in the specified region.
replicaConfigurations The configuration for replication.
replicaNames The replicas of the instance.
replicationClusters A primary instance and disaster recovery replica pair. Applicable to MySQL and PostgreSQL. This field can be set if the primary has psaWriteEndpoint set or both the primary and replica are created.
restoreBackupContexts Required.
rootPassword Initial root password. Required for MS SQL Server.
rootPasswordWo Initial root password. Required for MS SQL Server.
rootPasswordWoVersion Triggers update of rootPasswordWo write-only. For more info see updating write-only arguments
selfLink The URI of the created resource.
serverCaCerts Required.
serviceAccountEmailAddress The service account email address assigned to the instance.
settings The settings to use for the database. The configuration is detailed below.
switchTransactionLogsToCloudStorageEnabled When set to true, Cloud SQL instances can switch storing point-in-time recovery transaction logs from a data disk to Cloud Storage, freeing up data disk space and enabling longer retention windows. This is an input-only field that is not persisted in the API.
const
-
GetDatabaseInstancesInstance.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
availableMaintenanceVersions
→ Input<List<String>>
-
Available Maintenance versions.
final
-
backupdrBackup
→ Input<String>
-
The name of the BackupDR backup to restore from.
final
-
clones
→ Input<List<GetDatabaseInstancesInstanceClone>>
-
Configuration for creating a new instance as a clone of another instance.
final
-
connectionName
→ Input<String>
-
The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
final
-
databaseVersion
→ Input<String>
-
To filter out the Cloud SQL instances which are of the specified database version.
final
-
deletionPolicy
→ Input<String>
-
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE".
When a 'terraform destroy' or 'terraform apply' would delete the instance,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
final
-
deletionProtection
→ Input<bool>
-
Used to block Terraform from deleting a SQL Instance. Defaults to true.
final
-
dnsName
→ Input<String>
-
The instance-level dns name of the instance for PSC instances or public IP CAS instances.
final
-
dnsNames
→ Input<List<GetDatabaseInstancesInstanceDnsName>>
-
The list of DNS names used by this instance. Different connection types for an instance may have different DNS names. DNS names can apply to an individual instance or a cluster of instances.
final
-
encryptionKeyName
→ Input<String>
-
final
-
enforceNewSqlNetworkArchitecture
→ Input<bool>
-
Whether to enforce the new SQL network architecture.
final
-
finalBackupDescription
→ Input<String>
-
The description of final backup if instance enable create final backup during instance deletion.
final
-
firstIpAddress
→ Input<String>
-
The first IPv4 address of any type assigned. This is to support accessing the first address in the list in a terraform output when the resource is configured with a count.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
includeReplicasForMajorVersionUpgrade
→ Input<bool>
-
When this parameter is set to true, Cloud SQL instances can perform in-place major version upgrades of read replicas along with the primary instance when 'database_version' is updated. This is an input-only field that is not persisted in the API and only takes effect during a major version upgrade.
final
-
instanceType
→ Input<String>
-
The type of the instance. See https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instances#SqlInstanceType for supported values.
final
-
ipAddresses
→ Input<List<GetDatabaseInstancesInstanceIpAddress>>
-
final
-
maintenanceVersion
→ Input<String>
-
Maintenance version.
final
-
masterInstanceName
→ Input<String>
-
The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binaryLogEnabled set, as well as existing backups.
final
-
name
→ Input<String>
-
The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week.
final
-
nodeCount
→ Input<int>
-
For a read pool instance, the number of nodes in the read pool. For read pools with auto scaling enabled, this field is read only.
final
-
pointInTimeRestoreContexts
→ Input<List<GetDatabaseInstancesInstancePointInTimeRestoreContext>>
-
Configuration for creating a new instance using point-in-time-restore from backupdr backup.
final
-
privateIpAddress
→ Input<String>
-
IPv4 address assigned. This is a workaround for an issue fixed in Terraform 0.12 but also provides a convenient way to access an IP of a specific type without performing filtering in a Terraform config.
final
-
project
→ Input<String>
-
The ID of the project in which the resources belong. If it is not provided, the provider project is used.
final
-
pscServiceAttachmentLink
→ Input<String>
-
The link to service attachment of PSC instance.
final
-
publicIpAddress
→ Input<String>
-
IPv4 address assigned. This is a workaround for an issue fixed in Terraform 0.12 but also provides a convenient way to access an IP of a specific type without performing filtering in a Terraform config.
final
-
region
→ Input<String>
-
To filter out the Cloud SQL instances which are located in the specified region.
final
-
replicaConfigurations
→ Input<List<GetDatabaseInstancesInstanceReplicaConfiguration>>
-
The configuration for replication.
final
-
replicaNames
→ Input<List<String>>
-
The replicas of the instance.
final
-
replicationClusters
→ Input<List<GetDatabaseInstancesInstanceReplicationCluster>>
-
A primary instance and disaster recovery replica pair. Applicable to MySQL and PostgreSQL. This field can be set if the primary has psaWriteEndpoint set or both the primary and replica are created.
final
-
restoreBackupContexts
→ Input<List<GetDatabaseInstancesInstanceRestoreBackupContext>>
-
final
-
rootPassword
→ Input<String>
-
Initial root password. Required for MS SQL Server.
final
-
rootPasswordWo
→ Input<String>
-
Initial root password. Required for MS SQL Server.
Note: This property is write-only and will not be read from the API. For more info see updating write-only arguments
final
-
rootPasswordWoVersion
→ Input<String>
-
Triggers update of rootPasswordWo write-only. For more info see updating write-only arguments
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
selfLink
→ Input<String>
-
The URI of the created resource.
final
-
serverCaCerts
→ Input<List<GetDatabaseInstancesInstanceServerCaCert>>
-
final
-
serviceAccountEmailAddress
→ Input<String>
-
The service account email address assigned to the instance.
final
-
settings
→ Input<List<GetDatabaseInstancesInstanceSetting>>
-
The settings to use for the database. The configuration is detailed below.
final
-
switchTransactionLogsToCloudStorageEnabled
→ Input<bool>
-
When set to true, Cloud SQL instances can switch storing point-in-time recovery transaction logs from a data disk to Cloud Storage, freeing up data disk space and enabling longer retention windows. This is an input-only field that is not persisted in the API.
final
