google_api_sql_admin v0.25.0 GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance View Source
A Cloud SQL instance resource.
Attributes
backendType
(type:String.t
, default:nil
) -FIRST_GEN
: First Generation instance. MySQL only.SECOND_GEN
: Second Generation instance or PostgreSQL instance.EXTERNAL
: A database server that is not managed by Google.
This property is read-only; use thetier
property in thesettings
object to determine the database type and Second or First Generation.connectionName
(type:String.t
, default:nil
) - Connection name of the Cloud SQL instance used in connection strings.currentDiskSize
(type:String.t
, default:nil
) - The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see a href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ"this announcement for details.databaseVersion
(type:String.t
, default:nil
) - The database engine type and version. ThedatabaseVersion
field can not be changed after instance creation. MySQL Second Generation instances:MYSQL_5_7
(default) orMYSQL_5_6
. PostgreSQL instances:POSTGRES_9_6
(default) orPOSTGRES_11 Beta
MySQL First Generation instances:MYSQL_5_6
(default) orMYSQL_5_5
diskEncryptionConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionConfiguration.t
, default:nil
) - Disk encryption configuration specific to an instance. Applies only to Second Generation instances.diskEncryptionStatus
(type:GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionStatus.t
, default:nil
) - Disk encryption status specific to an instance. Applies only to Second Generation instances.etag
(type:String.t
, default:nil
) - This field is deprecated and will be removed from a future version of the API. Use thesettings.settingsVersion
field instead.failoverReplica
(type:GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstanceFailoverReplica.t
, default:nil
) - The name and status of the failover replica. This property is applicable only to Second Generation instances.gceZone
(type:String.t
, default:nil
) - 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
(type:String.t
, default:nil
) - The instance type. This can be one of the following.CLOUD_SQL_INSTANCE
: A Cloud SQL instance that is not replicating from a master.ON_PREMISES_INSTANCE
: An instance running on the customer's premises.READ_REPLICA_INSTANCE
: A Cloud SQL instance configured as a read-replica.ipAddresses
(type:list(GoogleApi.SQLAdmin.V1beta4.Model.IpMapping.t)
, default:nil
) - The assigned IP addresses for the instance.ipv6Address
(type:String.t
, default:nil
) - The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.kind
(type:String.t
, default:nil
) - This is alwayssql#instance
.masterInstanceName
(type:String.t
, default:nil
) - The name of the instance which will act as master in the replication setup.maxDiskSize
(type:String.t
, default:nil
) - The maximum disk size of the instance in bytes.name
(type:String.t
, default:nil
) - Name of the Cloud SQL instance. This does not include the project ID.onPremisesConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.OnPremisesConfiguration.t
, default:nil
) - Configuration specific to on-premises instances.project
(type:String.t
, default:nil
) - The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.region
(type:String.t
, default:nil
) - The geographical region. Can beus-central
(FIRST_GEN
instances only),us-central1
(SECOND_GEN
instances only),asia-east1
oreurope-west1
. Defaults tous-central
orus-central1
depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.replicaConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t
, default:nil
) - Configuration specific to failover replicas and read replicas.replicaNames
(type:list(String.t)
, default:nil
) - The replicas of the instance.rootPassword
(type:String.t
, default:nil
) - Initial root password. Use only on creation.scheduledMaintenance
(type:GoogleApi.SQLAdmin.V1beta4.Model.SqlScheduledMaintenance.t
, default:nil
) - The start time of any upcoming scheduled maintenance for this instance.selfLink
(type:String.t
, default:nil
) - The URI of this resource.serverCaCert
(type:GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t
, default:nil
) - SSL configuration.serviceAccountEmailAddress
(type:String.t
, default:nil
) - The service account email address assigned to the instance. This property is applicable only to Second Generation instances.settings
(type:GoogleApi.SQLAdmin.V1beta4.Model.Settings.t
, default:nil
) - The user settings.state
(type:String.t
, default:nil
) - The current serving state of the Cloud SQL instance. This can be one of the following.RUNNABLE
: The instance is running, or is ready to run when accessed.SUSPENDED
: The instance is not available, for example due to problems with billing.PENDING_CREATE
: The instance is being created.MAINTENANCE
: The instance is down for maintenance.FAILED
: The instance creation failed.UNKNOWN_STATE
: The state of the instance is unknown.suspensionReason
(type:list(String.t)
, default:nil
) - If the instance state is SUSPENDED, the reason for the suspension.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Sourcet() :: %GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance{ backendType: String.t(), connectionName: String.t(), currentDiskSize: String.t(), databaseVersion: String.t(), diskEncryptionConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionConfiguration.t(), diskEncryptionStatus: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionStatus.t(), etag: String.t(), failoverReplica: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstanceFailoverReplica.t(), gceZone: String.t(), instanceType: String.t(), ipAddresses: [GoogleApi.SQLAdmin.V1beta4.Model.IpMapping.t()], ipv6Address: String.t(), kind: String.t(), masterInstanceName: String.t(), maxDiskSize: String.t(), name: String.t(), onPremisesConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.OnPremisesConfiguration.t(), project: String.t(), region: String.t(), replicaConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t(), replicaNames: [String.t()], rootPassword: String.t(), scheduledMaintenance: GoogleApi.SQLAdmin.V1beta4.Model.SqlScheduledMaintenance.t(), selfLink: String.t(), serverCaCert: GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t(), serviceAccountEmailAddress: String.t(), settings: GoogleApi.SQLAdmin.V1beta4.Model.Settings.t(), state: String.t(), suspensionReason: [String.t()] }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.