SpannerDatabase

---

Property	Value
Google Cloud Service Name	Cloud Spanner
Google Cloud Service Documentation	/spanner/docs/
Google Cloud REST Resource Name	v1.projects.instances.databases
Google Cloud REST Resource Documentation	/spanner/docs/reference/rest/v1/projects.instances.databases
Config Connector Resource Short Names	gcpspannerdatabase gcpspannerdatabases spannerdatabase
Config Connector Service Name	spanner.googleapis.com
Config Connector Resource Fully Qualified Name	spannerdatabases.spanner.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	Yes
Supports IAM Conditions	Yes
Supports IAM Audit Configs	No
IAM External Reference Format	projects/{{project}}/instances/{{instance}}/databases/{{name}}
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id

Spec

Schema

databaseDialect: string
ddl:
- string
enableDropProtection: boolean
encryptionConfig:
  kmsKeyRef:
    external: string
    name: string
    namespace: string
instanceRef:
  external: string
  name: string
  namespace: string
resourceID: string
versionRetentionPeriod: string

Fields
databaseDialect Optional	string Immutable. The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values: ["GOOGLE_STANDARD_SQL", "POSTGRESQL"].
ddl Optional	list (string) An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
ddl[] Optional	string
enableDropProtection Optional	boolean
encryptionConfig Optional	object Immutable. Encryption configuration for the database.
encryptionConfig.kmsKeyRef Required*	object Fully qualified name of the KMS key to use to encrypt this database. This key must exist in the same location as the Spanner Database.
encryptionConfig.kmsKeyRef.external Optional	string Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
encryptionConfig.kmsKeyRef.name Optional	string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
encryptionConfig.kmsKeyRef.namespace Optional	string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
instanceRef Required	object The instance to create the database on.
instanceRef.external Optional	string Allowed value: The `name` field of a `SpannerInstance` resource.
instanceRef.name Optional	string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
instanceRef.namespace Optional	string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceID Optional	string Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.
versionRetentionPeriod Optional	string The retention period for the database. The retention period must be between 1 hour and 7 days, and can be specified in days, hours, minutes, or seconds. For example, the values 1d, 24h, 1440m, and 86400s are equivalent. Default value is 1h. If this property is used, you must avoid adding new DDL statements to 'ddl' that update the database's version_retention_period.

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
observedGeneration: integer
state: string

Fields
conditions	list (object) Conditions represent the latest available observation of the resource's current state.
conditions[]	object
conditions[].lastTransitionTime	string Last time the condition transitioned from one status to another.
conditions[].message	string Human-readable message indicating details about last transition.
conditions[].reason	string Unique, one-word, CamelCase reason for the condition's last transition.
conditions[].status	string Status is the status of the condition. Can be True, False, Unknown.
conditions[].type	string Type is the type of the condition.
observedGeneration	integer ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
state	string An explanation of the status of the database.

Sample YAML(s)

Typical Use Case

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: spanner.cnrm.cloud.google.com/v1beta1
kind: SpannerDatabase
metadata:
  name: spannerdatabase-sample
spec:
  instanceRef:
    name: spannerdatabase-dep
  ddl:
  - "CREATE TABLE t1 (t1 INT64 NOT NULL,) PRIMARY KEY(t1)"
---
apiVersion: spanner.cnrm.cloud.google.com/v1beta1
kind: SpannerInstance
metadata:
  name: spannerdatabase-dep
spec:
  config: regional-us-west1
  displayName: Spanner Database Dependency

Note: If you have any trouble with instantiating the resource, refer to Troubleshoot Config Connector.