Package-level declarations

Types

Link copied to clipboard
class Account : KotlinCustomResource

Manages a CosmosDB (formally DocumentDB) Account.

Link copied to clipboard
data class AccountArgs(val accessKeyMetadataWritesEnabled: Output<Boolean>? = null, val analyticalStorage: Output<AccountAnalyticalStorageArgs>? = null, val analyticalStorageEnabled: Output<Boolean>? = null, val automaticFailoverEnabled: Output<Boolean>? = null, val backup: Output<AccountBackupArgs>? = null, val burstCapacityEnabled: Output<Boolean>? = null, val capabilities: Output<List<AccountCapabilityArgs>>? = null, val capacity: Output<AccountCapacityArgs>? = null, val consistencyPolicy: Output<AccountConsistencyPolicyArgs>? = null, val corsRule: Output<AccountCorsRuleArgs>? = null, val createMode: Output<String>? = null, val defaultIdentityType: Output<String>? = null, val freeTierEnabled: Output<Boolean>? = null, val geoLocations: Output<List<AccountGeoLocationArgs>>? = null, val identity: Output<AccountIdentityArgs>? = null, val ipRangeFilters: Output<List<String>>? = null, val isVirtualNetworkFilterEnabled: Output<Boolean>? = null, val keyVaultKeyId: Output<String>? = null, val kind: Output<String>? = null, val localAuthenticationDisabled: Output<Boolean>? = null, val location: Output<String>? = null, val managedHsmKeyId: Output<String>? = null, val minimalTlsVersion: Output<String>? = null, val mongoServerVersion: Output<String>? = null, val multipleWriteLocationsEnabled: Output<Boolean>? = null, val name: Output<String>? = null, val networkAclBypassForAzureServices: Output<Boolean>? = null, val networkAclBypassIds: Output<List<String>>? = null, val offerType: Output<String>? = null, val partitionMergeEnabled: Output<Boolean>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val restore: Output<AccountRestoreArgs>? = null, val tags: Output<Map<String, String>>? = null, val virtualNetworkRules: Output<List<AccountVirtualNetworkRuleArgs>>? = null) : ConvertibleToJava<AccountArgs>

Manages a CosmosDB (formally DocumentDB) Account.

Link copied to clipboard
Link copied to clipboard
object AccountMapper : ResourceMapper<Account>
Link copied to clipboard
Link copied to clipboard
class CassandraCluster : KotlinCustomResource

Manages a Cassandra Cluster.

Link copied to clipboard
data class CassandraClusterArgs(val authenticationMethod: Output<String>? = null, val clientCertificatePems: Output<List<String>>? = null, val defaultAdminPassword: Output<String>? = null, val delegatedManagementSubnetId: Output<String>? = null, val externalGossipCertificatePems: Output<List<String>>? = null, val externalSeedNodeIpAddresses: Output<List<String>>? = null, val hoursBetweenBackups: Output<Int>? = null, val identity: Output<CassandraClusterIdentityArgs>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val repairEnabled: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val version: Output<String>? = null) : ConvertibleToJava<CassandraClusterArgs>

Manages a Cassandra Cluster.

Link copied to clipboard
object CassandraClusterMapper : ResourceMapper<CassandraCluster>
Link copied to clipboard
class CassandraDatacenter : KotlinCustomResource

Manages a Cassandra Datacenter.

Link copied to clipboard
data class CassandraDatacenterArgs(val availabilityZonesEnabled: Output<Boolean>? = null, val backupStorageCustomerKeyUri: Output<String>? = null, val base64EncodedYamlFragment: Output<String>? = null, val cassandraClusterId: Output<String>? = null, val delegatedManagementSubnetId: Output<String>? = null, val diskCount: Output<Int>? = null, val diskSku: Output<String>? = null, val location: Output<String>? = null, val managedDiskCustomerKeyUri: Output<String>? = null, val name: Output<String>? = null, val nodeCount: Output<Int>? = null, val skuName: Output<String>? = null) : ConvertibleToJava<CassandraDatacenterArgs>

Manages a Cassandra Datacenter.

Link copied to clipboard
Link copied to clipboard
class CassandraKeyspace : KotlinCustomResource

Manages a Cassandra KeySpace within a Cosmos DB Account.

Link copied to clipboard
data class CassandraKeyspaceArgs(val accountName: Output<String>? = null, val autoscaleSettings: Output<CassandraKeyspaceAutoscaleSettingsArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<CassandraKeyspaceArgs>

Manages a Cassandra KeySpace within a Cosmos DB Account.

Link copied to clipboard
object CassandraKeyspaceMapper : ResourceMapper<CassandraKeyspace>
Link copied to clipboard
class CassandraTable : KotlinCustomResource

Manages a Cassandra Table within a Cosmos DB Cassandra Keyspace.

Link copied to clipboard
data class CassandraTableArgs(val analyticalStorageTtl: Output<Int>? = null, val autoscaleSettings: Output<CassandraTableAutoscaleSettingsArgs>? = null, val cassandraKeyspaceId: Output<String>? = null, val defaultTtl: Output<Int>? = null, val name: Output<String>? = null, val schema: Output<CassandraTableSchemaArgs>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<CassandraTableArgs>

Manages a Cassandra Table within a Cosmos DB Cassandra Keyspace.

Link copied to clipboard
Link copied to clipboard
object CassandraTableMapper : ResourceMapper<CassandraTable>
Link copied to clipboard
Link copied to clipboard
class GremlinDatabase : KotlinCustomResource

Manages a Gremlin Database within a Cosmos DB Account.

Link copied to clipboard
data class GremlinDatabaseArgs(val accountName: Output<String>? = null, val autoscaleSettings: Output<GremlinDatabaseAutoscaleSettingsArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<GremlinDatabaseArgs>

Manages a Gremlin Database within a Cosmos DB Account.

Link copied to clipboard
object GremlinDatabaseMapper : ResourceMapper<GremlinDatabase>
Link copied to clipboard
class GremlinGraph : KotlinCustomResource

Manages a Gremlin Graph within a Cosmos DB Account.

Link copied to clipboard
data class GremlinGraphArgs(val accountName: Output<String>? = null, val analyticalStorageTtl: Output<Int>? = null, val autoscaleSettings: Output<GremlinGraphAutoscaleSettingsArgs>? = null, val conflictResolutionPolicy: Output<GremlinGraphConflictResolutionPolicyArgs>? = null, val databaseName: Output<String>? = null, val defaultTtl: Output<Int>? = null, val indexPolicy: Output<GremlinGraphIndexPolicyArgs>? = null, val name: Output<String>? = null, val partitionKeyPath: Output<String>? = null, val partitionKeyVersion: Output<Int>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null, val uniqueKeys: Output<List<GremlinGraphUniqueKeyArgs>>? = null) : ConvertibleToJava<GremlinGraphArgs>

Manages a Gremlin Graph within a Cosmos DB Account.

Link copied to clipboard
Link copied to clipboard
object GremlinGraphMapper : ResourceMapper<GremlinGraph>
Link copied to clipboard
Link copied to clipboard
class MongoCluster : KotlinCustomResource

Manages a MongoDB Cluster using vCore Architecture.

Link copied to clipboard
data class MongoClusterArgs(val administratorPassword: Output<String>? = null, val administratorUsername: Output<String>? = null, val computeTier: Output<String>? = null, val createMode: Output<String>? = null, val highAvailabilityMode: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val previewFeatures: Output<List<String>>? = null, val publicNetworkAccess: Output<String>? = null, val resourceGroupName: Output<String>? = null, val shardCount: Output<Int>? = null, val sourceLocation: Output<String>? = null, val sourceServerId: Output<String>? = null, val storageSizeInGb: Output<Int>? = null, val tags: Output<Map<String, String>>? = null, val version: Output<String>? = null) : ConvertibleToJava<MongoClusterArgs>

Manages a MongoDB Cluster using vCore Architecture.

Link copied to clipboard
Link copied to clipboard
object MongoClusterMapper : ResourceMapper<MongoCluster>
Link copied to clipboard
Link copied to clipboard
class MongoCollection : KotlinCustomResource

Manages a Mongo Collection within a Cosmos DB Account.

Link copied to clipboard
data class MongoCollectionArgs(val accountName: Output<String>? = null, val analyticalStorageTtl: Output<Int>? = null, val autoscaleSettings: Output<MongoCollectionAutoscaleSettingsArgs>? = null, val databaseName: Output<String>? = null, val defaultTtlSeconds: Output<Int>? = null, val indices: Output<List<MongoCollectionIndexArgs>>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val shardKey: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<MongoCollectionArgs>

Manages a Mongo Collection within a Cosmos DB Account.

Link copied to clipboard
object MongoCollectionMapper : ResourceMapper<MongoCollection>
Link copied to clipboard
class MongoDatabase : KotlinCustomResource

Manages a Mongo Database within a Cosmos DB Account.

Link copied to clipboard
data class MongoDatabaseArgs(val accountName: Output<String>? = null, val autoscaleSettings: Output<MongoDatabaseAutoscaleSettingsArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<MongoDatabaseArgs>

Manages a Mongo Database within a Cosmos DB Account.

Link copied to clipboard
Link copied to clipboard
object MongoDatabaseMapper : ResourceMapper<MongoDatabase>
Link copied to clipboard
Link copied to clipboard
class MongoRoleDefinition : KotlinCustomResource

Manages a Cosmos DB Mongo Role Definition.

Link copied to clipboard
data class MongoRoleDefinitionArgs(val cosmosMongoDatabaseId: Output<String>? = null, val inheritedRoleNames: Output<List<String>>? = null, val privileges: Output<List<MongoRoleDefinitionPrivilegeArgs>>? = null, val roleName: Output<String>? = null) : ConvertibleToJava<MongoRoleDefinitionArgs>

Manages a Cosmos DB Mongo Role Definition.

Link copied to clipboard
Link copied to clipboard
class MongoUserDefinition : KotlinCustomResource

Manages a Cosmos DB Mongo User Definition.

Link copied to clipboard
data class MongoUserDefinitionArgs(val cosmosMongoDatabaseId: Output<String>? = null, val inheritedRoleNames: Output<List<String>>? = null, val password: Output<String>? = null, val username: Output<String>? = null) : ConvertibleToJava<MongoUserDefinitionArgs>

Manages a Cosmos DB Mongo User Definition.

Link copied to clipboard
Link copied to clipboard
class PostgresqlCluster : KotlinCustomResource

Manages an Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
data class PostgresqlClusterArgs(val administratorLoginPassword: Output<String>? = null, val citusVersion: Output<String>? = null, val coordinatorPublicIpAccessEnabled: Output<Boolean>? = null, val coordinatorServerEdition: Output<String>? = null, val coordinatorStorageQuotaInMb: Output<Int>? = null, val coordinatorVcoreCount: Output<Int>? = null, val haEnabled: Output<Boolean>? = null, val location: Output<String>? = null, val maintenanceWindow: Output<PostgresqlClusterMaintenanceWindowArgs>? = null, val name: Output<String>? = null, val nodeCount: Output<Int>? = null, val nodePublicIpAccessEnabled: Output<Boolean>? = null, val nodeServerEdition: Output<String>? = null, val nodeStorageQuotaInMb: Output<Int>? = null, val nodeVcores: Output<Int>? = null, val pointInTimeInUtc: Output<String>? = null, val preferredPrimaryZone: Output<String>? = null, val resourceGroupName: Output<String>? = null, val shardsOnCoordinatorEnabled: Output<Boolean>? = null, val sourceLocation: Output<String>? = null, val sourceResourceId: Output<String>? = null, val sqlVersion: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<PostgresqlClusterArgs>

Manages an Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
object PostgresqlClusterMapper : ResourceMapper<PostgresqlCluster>
Link copied to clipboard
class PostgresqlCoordinatorConfiguration : KotlinCustomResource

Sets a Coordinator Configuration value on Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
data class PostgresqlCoordinatorConfigurationArgs(val clusterId: Output<String>? = null, val name: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<PostgresqlCoordinatorConfigurationArgs>

Sets a Coordinator Configuration value on Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
class PostgresqlFirewallRule : KotlinCustomResource

Manages an Azure Cosmos DB for PostgreSQL Firewall Rule.

Link copied to clipboard
data class PostgresqlFirewallRuleArgs(val clusterId: Output<String>? = null, val endIpAddress: Output<String>? = null, val name: Output<String>? = null, val startIpAddress: Output<String>? = null) : ConvertibleToJava<PostgresqlFirewallRuleArgs>

Manages an Azure Cosmos DB for PostgreSQL Firewall Rule.

Link copied to clipboard
Link copied to clipboard
class PostgresqlNodeConfiguration : KotlinCustomResource

Sets a Node Configuration value on Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
data class PostgresqlNodeConfigurationArgs(val clusterId: Output<String>? = null, val name: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<PostgresqlNodeConfigurationArgs>

Sets a Node Configuration value on Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
class PostgresqlRole : KotlinCustomResource

Manages an Azure Cosmos DB for PostgreSQL Role.

Link copied to clipboard
data class PostgresqlRoleArgs(val clusterId: Output<String>? = null, val name: Output<String>? = null, val password: Output<String>? = null) : ConvertibleToJava<PostgresqlRoleArgs>

Manages an Azure Cosmos DB for PostgreSQL Role.

Link copied to clipboard
Link copied to clipboard
object PostgresqlRoleMapper : ResourceMapper<PostgresqlRole>
Link copied to clipboard
class SqlContainer : KotlinCustomResource

Manages a SQL Container within a Cosmos DB Account.

Link copied to clipboard
data class SqlContainerArgs(val accountName: Output<String>? = null, val analyticalStorageTtl: Output<Int>? = null, val autoscaleSettings: Output<SqlContainerAutoscaleSettingsArgs>? = null, val conflictResolutionPolicy: Output<SqlContainerConflictResolutionPolicyArgs>? = null, val databaseName: Output<String>? = null, val defaultTtl: Output<Int>? = null, val indexingPolicy: Output<SqlContainerIndexingPolicyArgs>? = null, val name: Output<String>? = null, val partitionKeyKind: Output<String>? = null, val partitionKeyPaths: Output<List<String>>? = null, val partitionKeyVersion: Output<Int>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null, val uniqueKeys: Output<List<SqlContainerUniqueKeyArgs>>? = null) : ConvertibleToJava<SqlContainerArgs>

Manages a SQL Container within a Cosmos DB Account.

Link copied to clipboard
Link copied to clipboard
object SqlContainerMapper : ResourceMapper<SqlContainer>
Link copied to clipboard
Link copied to clipboard
class SqlDatabase : KotlinCustomResource

Manages a SQL Database within a Cosmos DB Account.

Link copied to clipboard
data class SqlDatabaseArgs(val accountName: Output<String>? = null, val autoscaleSettings: Output<SqlDatabaseAutoscaleSettingsArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<SqlDatabaseArgs>

Manages a SQL Database within a Cosmos DB Account.

Link copied to clipboard
Link copied to clipboard
object SqlDatabaseMapper : ResourceMapper<SqlDatabase>
Link copied to clipboard
Link copied to clipboard
class SqlDedicatedGateway : KotlinCustomResource

Manages a SQL Dedicated Gateway within a Cosmos DB Account.

Link copied to clipboard
data class SqlDedicatedGatewayArgs(val cosmosdbAccountId: Output<String>? = null, val instanceCount: Output<Int>? = null, val instanceSize: Output<String>? = null) : ConvertibleToJava<SqlDedicatedGatewayArgs>

Manages a SQL Dedicated Gateway within a Cosmos DB Account.

Link copied to clipboard
Link copied to clipboard
class SqlFunction : KotlinCustomResource

Manages an SQL User Defined Function.

Link copied to clipboard
data class SqlFunctionArgs(val body: Output<String>? = null, val containerId: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<SqlFunctionArgs>

Manages an SQL User Defined Function.

Link copied to clipboard
Link copied to clipboard
object SqlFunctionMapper : ResourceMapper<SqlFunction>
Link copied to clipboard
Link copied to clipboard
class SqlRoleAssignment : KotlinCustomResource

Manages a Cosmos DB SQL Role Assignment.

Link copied to clipboard
data class SqlRoleAssignmentArgs(val accountName: Output<String>? = null, val name: Output<String>? = null, val principalId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val roleDefinitionId: Output<String>? = null, val scope: Output<String>? = null) : ConvertibleToJava<SqlRoleAssignmentArgs>

Manages a Cosmos DB SQL Role Assignment.

Link copied to clipboard
object SqlRoleAssignmentMapper : ResourceMapper<SqlRoleAssignment>
Link copied to clipboard
class SqlRoleDefinition : KotlinCustomResource

Manages a Cosmos DB SQL Role Definition.

Link copied to clipboard
data class SqlRoleDefinitionArgs(val accountName: Output<String>? = null, val assignableScopes: Output<List<String>>? = null, val name: Output<String>? = null, val permissions: Output<List<SqlRoleDefinitionPermissionArgs>>? = null, val resourceGroupName: Output<String>? = null, val roleDefinitionId: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<SqlRoleDefinitionArgs>

Manages a Cosmos DB SQL Role Definition.

Link copied to clipboard
object SqlRoleDefinitionMapper : ResourceMapper<SqlRoleDefinition>
Link copied to clipboard
class SqlStoredProcedure : KotlinCustomResource

Manages a SQL Stored Procedure within a Cosmos DB Account SQL Database.

Link copied to clipboard
data class SqlStoredProcedureArgs(val accountName: Output<String>? = null, val body: Output<String>? = null, val containerName: Output<String>? = null, val databaseName: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<SqlStoredProcedureArgs>

Manages a SQL Stored Procedure within a Cosmos DB Account SQL Database.

Link copied to clipboard
Link copied to clipboard
class SqlTrigger : KotlinCustomResource

Manages an SQL Trigger.

Link copied to clipboard
data class SqlTriggerArgs(val body: Output<String>? = null, val containerId: Output<String>? = null, val name: Output<String>? = null, val operation: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<SqlTriggerArgs>

Manages an SQL Trigger.

Link copied to clipboard
Link copied to clipboard
object SqlTriggerMapper : ResourceMapper<SqlTrigger>
Link copied to clipboard
Link copied to clipboard
class Table : KotlinCustomResource

Manages a Table within a Cosmos DB Account.

Link copied to clipboard
data class TableArgs(val accountName: Output<String>? = null, val autoscaleSettings: Output<TableAutoscaleSettingsArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val throughput: Output<Int>? = null) : ConvertibleToJava<TableArgs>

Manages a Table within a Cosmos DB Account.

Link copied to clipboard

Builder for TableArgs.

Link copied to clipboard
object TableMapper : ResourceMapper<Table>
Link copied to clipboard

Builder for Table.

Functions

Link copied to clipboard
fun account(name: String): Account
suspend fun account(name: String, block: suspend AccountResourceBuilder.() -> Unit): Account
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun sqlDatabase(name: String, block: suspend SqlDatabaseResourceBuilder.() -> Unit): SqlDatabase
Link copied to clipboard
suspend fun sqlFunction(name: String, block: suspend SqlFunctionResourceBuilder.() -> Unit): SqlFunction
Link copied to clipboard
suspend fun sqlTrigger(name: String, block: suspend SqlTriggerResourceBuilder.() -> Unit): SqlTrigger
Link copied to clipboard
fun table(name: String): Table
suspend fun table(name: String, block: suspend TableResourceBuilder.() -> Unit): Table