Instance class

Creates a new Cloud SQL instance.

Constructors

Instance(String name, {InstanceArgs? args, CustomResourceOptions? options})
Creates a new Instance. name The Pulumi resource name. args Arguments used to configure this Instance. The set of arguments for Instance. options Resource options controlling this resource's behavior.

Properties

availableMaintenanceVersions ↔ Output<List<String>>
List all maintenance versions applicable on the instance
latefinal
backendType ↔ Output<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.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
connectionName ↔ Output<String>
Connection name of the Cloud SQL instance used in connection strings.
latefinal
createTime ↔ Output<String>
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
latefinal
currentDiskSize ↔ Output<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.
latefinal
databaseInstalledVersion ↔ Output<String>
Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
latefinal
databaseVersion ↔ Output<String>
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
latefinal
diskEncryptionConfiguration ↔ Output<DiskEncryptionConfigurationResponse>
Disk encryption configuration specific to an instance.
latefinal
diskEncryptionStatus ↔ Output<DiskEncryptionStatusResponse>
Disk encryption status specific to an instance.
latefinal
dnsName ↔ Output<String>
The dns name of the instance.
latefinal
etag ↔ Output<String>
This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
latefinal
failoverReplica ↔ Output<InstanceFailoverReplicaResponse>
The name and status of the failover replica.
latefinal
gceZone ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceType ↔ Output<String>
The instance type.
latefinal
ipAddresses ↔ Output<List<Map<String, dynamic>>>
The assigned IP addresses for the instance.
latefinal
ipv6Address ↔ Output<String>
The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kind ↔ Output<String>
This is always sql#instance.
latefinal
maintenanceVersion ↔ Output<String>
The current software version on the instance.
latefinal
masterInstanceName ↔ Output<String>
The name of the instance which will act as primary in the replication setup.
latefinal
maxDiskSize ↔ Output<String>
The maximum disk size of the instance in bytes.
latefinal
name ↔ Output<String>
Name of the Cloud SQL instance. This does not include the project ID.
latefinal
onPremisesConfiguration ↔ Output<OnPremisesConfigurationResponse>
Configuration specific to on-premises instances.
latefinal
outOfDiskReport ↔ Output<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
latefinal
primaryDnsName ↔ Output<String>
DEPRECATED: please use write_endpoint instead.
latefinal
project ↔ Output<String>
latefinal
The link to service attachment of PSC instance.
latefinal
region ↔ Output<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.
latefinal
replicaConfiguration ↔ Output<ReplicaConfigurationResponse>
Configuration specific to failover replicas and read replicas.
latefinal
replicaNames ↔ Output<List<String>>
The replicas of the instance.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
rootPassword ↔ Output<String>
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs ↔ Output<bool>
The status indicating if instance satisfiesPzs. Reserved for future use.
latefinal
scheduledMaintenance ↔ Output<SqlScheduledMaintenanceResponse>
The start time of any upcoming scheduled maintenance for this instance.
latefinal
secondaryGceZone ↔ Output<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.
latefinal
The URI of this resource.
latefinal
serverCaCert ↔ Output<SslCertResponse>
SSL configuration.
latefinal
serviceAccountEmailAddress ↔ Output<String>
The service account email address assigned to the instance.\This property is read-only.
latefinal
settings ↔ Output<SettingsResponse>
The user settings.
latefinal
sqlNetworkArchitecture ↔ Output<String>
latefinal
state ↔ Output<String>
The current serving state of the Cloud SQL instance.
latefinal
suspensionReason ↔ Output<List<String>>
If the instance state is SUSPENDED, the reason for the suspension.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
writeEndpoint ↔ Output<String>
The dns name of the primary instance in a replication group.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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