Package-level declarations

Types

Link copied to clipboard
class BackupSchedule : KotlinCustomResource

A backup schedule for a Cloud Spanner Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. To get more information about BackupSchedule, see:

Link copied to clipboard
data class BackupScheduleArgs(val database: Output<String>? = null, val encryptionConfig: Output<BackupScheduleEncryptionConfigArgs>? = null, val fullBackupSpec: Output<BackupScheduleFullBackupSpecArgs>? = null, val incrementalBackupSpec: Output<BackupScheduleIncrementalBackupSpecArgs>? = null, val instance: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val retentionDuration: Output<String>? = null, val spec: Output<BackupScheduleSpecArgs>? = null) : ConvertibleToJava<BackupScheduleArgs>

A backup schedule for a Cloud Spanner Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. To get more information about BackupSchedule, see:

Link copied to clipboard
Link copied to clipboard
object BackupScheduleMapper : ResourceMapper<BackupSchedule>
Link copied to clipboard
class Database : KotlinCustomResource

A Cloud Spanner Database which is hosted on a Spanner instance. To get more information about Database, see:

Link copied to clipboard
data class DatabaseArgs(val databaseDialect: Output<String>? = null, val ddls: Output<List<String>>? = null, val defaultTimeZone: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val enableDropProtection: Output<Boolean>? = null, val encryptionConfig: Output<DatabaseEncryptionConfigArgs>? = null, val instance: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val versionRetentionPeriod: Output<String>? = null) : ConvertibleToJava<DatabaseArgs>

A Cloud Spanner Database which is hosted on a Spanner instance. To get more information about Database, see:

Link copied to clipboard
Link copied to clipboard
class DatabaseIAMBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
data class DatabaseIAMBindingArgs(val condition: Output<DatabaseIAMBindingConditionArgs>? = null, val database: Output<String>? = null, val instance: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<DatabaseIAMBindingArgs>

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class DatabaseIAMMember : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
data class DatabaseIAMMemberArgs(val condition: Output<DatabaseIAMMemberConditionArgs>? = null, val database: Output<String>? = null, val instance: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<DatabaseIAMMemberArgs>

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
object DatabaseIAMMemberMapper : ResourceMapper<DatabaseIAMMember>
Link copied to clipboard
class DatabaseIAMPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
data class DatabaseIAMPolicyArgs(val database: Output<String>? = null, val instance: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<DatabaseIAMPolicyArgs>

Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:

Link copied to clipboard
object DatabaseIAMPolicyMapper : ResourceMapper<DatabaseIAMPolicy>
Link copied to clipboard
object DatabaseMapper : ResourceMapper<Database>
Link copied to clipboard
Link copied to clipboard
class Instance : KotlinCustomResource

An isolated set of Cloud Spanner resources on which databases can be hosted. To get more information about Instance, see:

Link copied to clipboard
data class InstanceArgs(val autoscalingConfig: Output<InstanceAutoscalingConfigArgs>? = null, val config: Output<String>? = null, val defaultBackupScheduleType: Output<String>? = null, val displayName: Output<String>? = null, val edition: Output<String>? = null, val forceDestroy: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val name: Output<String>? = null, val numNodes: Output<Int>? = null, val processingUnits: Output<Int>? = null, val project: Output<String>? = null) : ConvertibleToJava<InstanceArgs>

An isolated set of Cloud Spanner resources on which databases can be hosted. To get more information about Instance, see:

Link copied to clipboard
Link copied to clipboard
class InstanceConfig : KotlinCustomResource

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. To get more information about InstanceConfig, see:

Link copied to clipboard
data class InstanceConfigArgs(val baseConfig: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val replicas: Output<List<InstanceConfigReplicaArgs>>? = null) : ConvertibleToJava<InstanceConfigArgs>

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. To get more information about InstanceConfig, see:

Link copied to clipboard
Link copied to clipboard
object InstanceConfigMapper : ResourceMapper<InstanceConfig>
Link copied to clipboard
class InstanceIAMBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
data class InstanceIAMBindingArgs(val condition: Output<InstanceIAMBindingConditionArgs>? = null, val instance: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<InstanceIAMBindingArgs>

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class InstanceIAMMember : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
data class InstanceIAMMemberArgs(val condition: Output<InstanceIAMMemberConditionArgs>? = null, val instance: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<InstanceIAMMemberArgs>

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
object InstanceIAMMemberMapper : ResourceMapper<InstanceIAMMember>
Link copied to clipboard
class InstanceIAMPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
data class InstanceIAMPolicyArgs(val instance: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<InstanceIAMPolicyArgs>

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

Link copied to clipboard
object InstanceIAMPolicyMapper : ResourceMapper<InstanceIAMPolicy>
Link copied to clipboard
object InstanceMapper : ResourceMapper<Instance>
Link copied to clipboard
class InstancePartition : KotlinCustomResource

A Cloud Spanner instance partition is a unit of Cloud Spanner database capacity that can be used to partition data and processing capacity within an instance. To get more information about InstancePartition, see:

Link copied to clipboard
data class InstancePartitionArgs(val config: Output<String>? = null, val displayName: Output<String>? = null, val instance: Output<String>? = null, val name: Output<String>? = null, val nodeCount: Output<Int>? = null, val processingUnits: Output<Int>? = null, val project: Output<String>? = null) : ConvertibleToJava<InstancePartitionArgs>

A Cloud Spanner instance partition is a unit of Cloud Spanner database capacity that can be used to partition data and processing capacity within an instance. To get more information about InstancePartition, see:

Link copied to clipboard
object InstancePartitionMapper : ResourceMapper<InstancePartition>
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database
Link copied to clipboard
suspend fun instance(name: String, block: suspend InstanceResourceBuilder.() -> Unit): Instance
Link copied to clipboard