DatabaseState class

Input properties used for looking up and filtering Database resources.

Constructors

DatabaseState({Input<String?>? databaseDialect, Input<List<String>?>? ddls, Input<String?>? defaultTimeZone, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<bool?>? enableDropProtection, Input<DatabaseEncryptionConfig?>? encryptionConfig, Input<String?>? instance, Input<String?>? name, Input<String?>? project, Input<String?>? state, Input<String?>? versionRetentionPeriod})
Creates a new DatabaseState. databaseDialect The dialect of the Cloud Spanner Database. ddls An optional list of DDL statements to run inside the database. Statements can create defaultTimeZone The default time zone for the database. The default time zone must be a valid name deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtection Whether or not to allow the provider to destroy the instance. Unless this field is set to false enableDropProtection Whether drop protection is enabled for this database. Defaults to false. encryptionConfig Encryption configuration for the database instance The instance to create the database on. name A unique identifier for the database, which cannot be changed after the project The ID of the project in which the resource belongs. state An explanation of the status of the database. versionRetentionPeriod The retention period for the database. The retention period must be between 1 hour
const
DatabaseState.fromMap(Map<String, dynamic> map)
factory

Properties

databaseDialect → Input<String?>?
The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values are: GOOGLE_STANDARD_SQL, POSTGRESQL.
final
ddls → Input<List<String>?>?
An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc. During creation these statements execute atomically with the creation of the database and if there is an error in any statement, the database is not created. Terraform does not perform drift detection on this field and assumes that the values recorded in state are accurate. Limited updates to this field are supported, and newly appended DDL statements can be executed in an update. However, modifications to prior statements will create a plan that marks the resource for recreation.
final
defaultTimeZone → Input<String?>?
The default time zone for the database. The default time zone must be a valid name from the tz database. Default value is "America/Los_angeles".
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, 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?>?
Whether or not to allow the provider to destroy the instance. Unless this field is set to false in state, a destroy or update that would delete the instance will fail.
final
enableDropProtection → Input<bool?>?
Whether drop protection is enabled for this database. Defaults to false. Drop protection is different from the "deletionProtection" attribute in the following ways: (1) "deletionProtection" only protects the database from deletions in Terraform. whereas setting “enableDropProtection” to true protects the database from deletions in all interfaces. (2) Setting "enableDropProtection" to true also prevents the deletion of the parent instance containing the database. "deletionProtection" attribute does not provide protection against the deletion of the parent instance.
final
encryptionConfig → Input<DatabaseEncryptionConfig?>?
Encryption configuration for the database Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
instance → Input<String?>?
The instance to create the database on.
final
name → Input<String?>?
A unique identifier for the database, which cannot be changed after the instance is created. Values are of the form [a-z][-_a-z0-9]*[a-z0-9].
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
An explanation of the status of the database.
final
versionRetentionPeriod → Input<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.
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