InstanceArgs class

The set of arguments for Instance. The set of arguments for Instance.

Constructors

InstanceArgs({Input<InstanceBackendType>? backendType, Input<String>? connectionName, Input<String>? currentDiskSize, Input<InstanceDatabaseVersion>? databaseVersion, Input<DiskEncryptionConfiguration>? diskEncryptionConfiguration, Input<DiskEncryptionStatus>? diskEncryptionStatus, Input<String>? etag, Input<InstanceFailoverReplica>? failoverReplica, Input<String>? gceZone, Input<InstanceInstanceType>? instanceType, Input<List<IpMapping>>? ipAddresses, Input<String>? ipv6Address, Input<String>? kind, Input<String>? maintenanceVersion, Input<String>? masterInstanceName, Input<String>? maxDiskSize, Input<String>? name, Input<OnPremisesConfiguration>? onPremisesConfiguration, Input<SqlOutOfDiskReport>? outOfDiskReport, Input<String>? project, Input<String>? region, Input<ReplicaConfiguration>? replicaConfiguration, Input<List<String>>? replicaNames, Input<String>? rootPassword, Input<bool>? satisfiesPzs, Input<SqlScheduledMaintenance>? scheduledMaintenance, Input<String>? secondaryGceZone, Input<String>? selfLink, Input<SslCertSqladminV1>? serverCaCert, Input<String>? serviceAccountEmailAddress, Input<Settings>? settings, Input<InstanceSqlNetworkArchitecture>? sqlNetworkArchitecture, Input<InstanceState>? state, Input<List<InstanceSuspensionReasonItem>>? suspensionReason})
Creates a new InstanceArgs. backendType 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 Connection name of the Cloud SQL instance used in connection strings. currentDiskSize 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. databaseVersion The database engine type and version. The databaseVersion field cannot be changed after instance creation. diskEncryptionConfiguration Disk encryption configuration specific to an instance. diskEncryptionStatus Disk encryption status specific to an instance. etag This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. failoverReplica The name and status of the failover replica. gceZone 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. WARNING: Changing this might restart the instance. instanceType The instance type. ipAddresses The assigned IP addresses for the instance. ipv6Address The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. kind This is always sql#instance. maintenanceVersion The current software version on the instance. masterInstanceName The name of the instance which will act as primary in the replication setup. maxDiskSize The maximum disk size of the instance in bytes. name Name of the Cloud SQL instance. This does not include the project ID. onPremisesConfiguration Configuration specific to on-premises instances. outOfDiskReport 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 The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. region 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 Configuration specific to failover replicas and read replicas. replicaNames The replicas of the instance. rootPassword Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. satisfiesPzs The status indicating if instance satisfiesPzs. Reserved for future use. scheduledMaintenance The start time of any upcoming scheduled maintenance for this instance. secondaryGceZone 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. selfLink The URI of this resource. serverCaCert SSL configuration. serviceAccountEmailAddress The service account email address assigned to the instance.\This property is read-only. settings The user settings. sqlNetworkArchitecture Optional. state The current serving state of the Cloud SQL instance. suspensionReason If the instance state is SUSPENDED, the reason for the suspension.
const
InstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

backendType → Input<InstanceBackendType>?
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.
final
connectionName → Input<String>?
Connection name of the Cloud SQL instance used in connection strings.
final
currentDiskSize → Input<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.
final
databaseVersion → Input<InstanceDatabaseVersion>?
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
final
diskEncryptionConfiguration → Input<DiskEncryptionConfiguration>?
Disk encryption configuration specific to an instance.
final
diskEncryptionStatus → Input<DiskEncryptionStatus>?
Disk encryption status specific to an instance.
final
etag → Input<String>?
This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
final
failoverReplica → Input<InstanceFailoverReplica>?
The name and status of the failover replica.
final
gceZone → Input<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. WARNING: Changing this might restart the instance.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceType → Input<InstanceInstanceType>?
The instance type.
final
ipAddresses → Input<List<IpMapping>>?
The assigned IP addresses for the instance.
final
ipv6Address → Input<String>?
The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
final
kind → Input<String>?
This is always sql#instance.
final
maintenanceVersion → Input<String>?
The current software version on the instance.
final
masterInstanceName → Input<String>?
The name of the instance which will act as primary in the replication setup.
final
maxDiskSize → Input<String>?
The maximum disk size of the instance in bytes.
final
name → Input<String>?
Name of the Cloud SQL instance. This does not include the project ID.
final
onPremisesConfiguration → Input<OnPremisesConfiguration>?
Configuration specific to on-premises instances.
final
outOfDiskReport → Input<SqlOutOfDiskReport>?
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
final
project → Input<String>?
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
final
region → Input<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.
final
replicaConfiguration → Input<ReplicaConfiguration>?
Configuration specific to failover replicas and read replicas.
final
replicaNames → Input<List<String>>?
The replicas of the instance.
final
rootPassword → Input<String>?
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → Input<bool>?
The status indicating if instance satisfiesPzs. Reserved for future use.
final
scheduledMaintenance → Input<SqlScheduledMaintenance>?
The start time of any upcoming scheduled maintenance for this instance.
final
secondaryGceZone → Input<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.
final
The URI of this resource.
final
serverCaCert → Input<SslCertSqladminV1>?
SSL configuration.
final
serviceAccountEmailAddress → Input<String>?
The service account email address assigned to the instance.\This property is read-only.
final
settings → Input<Settings>?
The user settings.
final
sqlNetworkArchitecture → Input<InstanceSqlNetworkArchitecture>?
final
state → Input<InstanceState>?
The current serving state of the Cloud SQL instance.
final
suspensionReason → Input<List<InstanceSuspensionReasonItem>>?
If the instance state is SUSPENDED, the reason for the suspension.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited