Package-level declarations

Types

Link copied to clipboard
class ActiveDirectory : KotlinCustomResource

ActiveDirectory is the public representation of the active directory config. To get more information about ActiveDirectory, see:

Link copied to clipboard
data class ActiveDirectoryArgs(val administrators: Output<List<String>>? = null, val aesEncryption: Output<Boolean>? = null, val backupOperators: Output<List<String>>? = null, val description: Output<String>? = null, val dns: Output<String>? = null, val domain: Output<String>? = null, val encryptDcConnections: Output<Boolean>? = null, val kdcHostname: Output<String>? = null, val kdcIp: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val ldapSigning: Output<Boolean>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val netBiosPrefix: Output<String>? = null, val nfsUsersWithLdap: Output<Boolean>? = null, val organizationalUnit: Output<String>? = null, val password: Output<String>? = null, val project: Output<String>? = null, val securityOperators: Output<List<String>>? = null, val site: Output<String>? = null, val username: Output<String>? = null) : ConvertibleToJava<ActiveDirectoryArgs>

ActiveDirectory is the public representation of the active directory config. To get more information about ActiveDirectory, see:

Link copied to clipboard
object ActiveDirectoryMapper : ResourceMapper<ActiveDirectory>
Link copied to clipboard
class Backup : KotlinCustomResource

NetApp Volumes supports volume backups, which are copies of your volumes stored independently from the volume. Backups are stored in backup vaults, which are containers for backups. If a volume is lost or deleted, you can use backups to restore your data to a new volume. When you create the first backup of a volume, all of the volume's used data is sent to the backup vault. Subsequent backups of the same volume only include data that has changed from the previous backup. This allows for fast incremental-forever backups and reduces the required capacity inside the backup vault. You can create manual and scheduled backups. Manual backups can be taken from a volume or from an existing volume snapshot. Scheduled backups require a backup policy. To get more information about Backup, see:

Link copied to clipboard
data class BackupArgs(val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val sourceSnapshot: Output<String>? = null, val sourceVolume: Output<String>? = null, val vaultName: Output<String>? = null) : ConvertibleToJava<BackupArgs>

NetApp Volumes supports volume backups, which are copies of your volumes stored independently from the volume. Backups are stored in backup vaults, which are containers for backups. If a volume is lost or deleted, you can use backups to restore your data to a new volume. When you create the first backup of a volume, all of the volume's used data is sent to the backup vault. Subsequent backups of the same volume only include data that has changed from the previous backup. This allows for fast incremental-forever backups and reduces the required capacity inside the backup vault. You can create manual and scheduled backups. Manual backups can be taken from a volume or from an existing volume snapshot. Scheduled backups require a backup policy. To get more information about Backup, see:

Link copied to clipboard

Builder for BackupArgs.

Link copied to clipboard
object BackupMapper : ResourceMapper<Backup>
Link copied to clipboard
class BackupPolicy : KotlinCustomResource

A backup policy is used to schedule backups at regular daily, weekly, or monthly intervals. Backup policies allow you to attach a backup schedule to a volume. The policy defines how many backups to retain at daily, weekly, or monthly intervals. To get more information about BackupPolicy, see:

Link copied to clipboard
data class BackupPolicyArgs(val dailyBackupLimit: Output<Int>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val monthlyBackupLimit: Output<Int>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val weeklyBackupLimit: Output<Int>? = null) : ConvertibleToJava<BackupPolicyArgs>

A backup policy is used to schedule backups at regular daily, weekly, or monthly intervals. Backup policies allow you to attach a backup schedule to a volume. The policy defines how many backups to retain at daily, weekly, or monthly intervals. To get more information about BackupPolicy, see:

Link copied to clipboard
Link copied to clipboard
object BackupPolicyMapper : ResourceMapper<BackupPolicy>
Link copied to clipboard
Link copied to clipboard

Builder for Backup.

Link copied to clipboard
class BackupVault : KotlinCustomResource

A backup vault is the location where backups are stored. You can only create one backup vault per region. A vault can hold multiple backups for multiple volumes in that region. To get more information about BackupVault, see:

Link copied to clipboard
data class BackupVaultArgs(val backupRegion: Output<String>? = null, val backupVaultType: Output<String>? = null, val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<BackupVaultArgs>

A backup vault is the location where backups are stored. You can only create one backup vault per region. A vault can hold multiple backups for multiple volumes in that region. To get more information about BackupVault, see:

Link copied to clipboard
Link copied to clipboard
object BackupVaultMapper : ResourceMapper<BackupVault>
Link copied to clipboard
Link copied to clipboard
class Kmsconfig : KotlinCustomResource

NetApp Volumes always encrypts your data at rest using volume-specific keys. A CMEK policy (customer-managed encryption key) warps such volume-specific keys in a key stored in Cloud Key Management Service (KMS). To get more information about kmsconfig, see:

Link copied to clipboard
data class KmsconfigArgs(val cryptoKeyName: Output<String>? = null, val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<KmsconfigArgs>

NetApp Volumes always encrypts your data at rest using volume-specific keys. A CMEK policy (customer-managed encryption key) warps such volume-specific keys in a key stored in Cloud Key Management Service (KMS). To get more information about kmsconfig, see:

Link copied to clipboard
Link copied to clipboard
object KmsconfigMapper : ResourceMapper<Kmsconfig>
Link copied to clipboard
Link copied to clipboard
class StoragePool : KotlinCustomResource
Link copied to clipboard
data class StoragePoolArgs(val activeDirectory: Output<String>? = null, val allowAutoTiering: Output<Boolean>? = null, val capacityGib: Output<String>? = null, val customPerformanceEnabled: Output<Boolean>? = null, val description: Output<String>? = null, val kmsConfig: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val ldapEnabled: Output<Boolean>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val network: Output<String>? = null, val project: Output<String>? = null, val replicaZone: Output<String>? = null, val serviceLevel: Output<String>? = null, val totalIops: Output<String>? = null, val totalThroughputMibps: Output<String>? = null, val zone: Output<String>? = null) : ConvertibleToJava<StoragePoolArgs>
Link copied to clipboard
Link copied to clipboard
object StoragePoolMapper : ResourceMapper<StoragePool>
Link copied to clipboard
Link copied to clipboard
class Volume : KotlinCustomResource

A volume is a file system container in a storage pool that stores application, database, and user data. You can create a volume's capacity using the available capacity in the storage pool and you can define and resize the capacity without disruption to any processes. Storage pool settings apply to the volumes contained within them automatically. To get more information about Volume, see:

Link copied to clipboard
data class VolumeArgs(val backupConfig: Output<VolumeBackupConfigArgs>? = null, val capacityGib: Output<String>? = null, val deletionPolicy: Output<String>? = null, val description: Output<String>? = null, val exportPolicy: Output<VolumeExportPolicyArgs>? = null, val kerberosEnabled: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val largeCapacity: Output<Boolean>? = null, val location: Output<String>? = null, val multipleEndpoints: Output<Boolean>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val protocols: Output<List<String>>? = null, val restoreParameters: Output<VolumeRestoreParametersArgs>? = null, val restrictedActions: Output<List<String>>? = null, val securityStyle: Output<String>? = null, val shareName: Output<String>? = null, val smbSettings: Output<List<String>>? = null, val snapshotDirectory: Output<Boolean>? = null, val snapshotPolicy: Output<VolumeSnapshotPolicyArgs>? = null, val storagePool: Output<String>? = null, val tieringPolicy: Output<VolumeTieringPolicyArgs>? = null, val unixPermissions: Output<String>? = null) : ConvertibleToJava<VolumeArgs>

A volume is a file system container in a storage pool that stores application, database, and user data. You can create a volume's capacity using the available capacity in the storage pool and you can define and resize the capacity without disruption to any processes. Storage pool settings apply to the volumes contained within them automatically. To get more information about Volume, see:

Link copied to clipboard

Builder for VolumeArgs.

Link copied to clipboard
object VolumeMapper : ResourceMapper<Volume>
Link copied to clipboard
class VolumeQuotaRule : KotlinCustomResource

QuotaRule specifies the maximum capacity a user or group can use within a volume. They can be used for creating default and individual quota rules. To get more information about VolumeQuotaRule, see:

Link copied to clipboard
data class VolumeQuotaRuleArgs(val description: Output<String>? = null, val diskLimitMib: Output<Int>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val target: Output<String>? = null, val type: Output<String>? = null, val volumeName: Output<String>? = null) : ConvertibleToJava<VolumeQuotaRuleArgs>

QuotaRule specifies the maximum capacity a user or group can use within a volume. They can be used for creating default and individual quota rules. To get more information about VolumeQuotaRule, see:

Link copied to clipboard
object VolumeQuotaRuleMapper : ResourceMapper<VolumeQuotaRule>
Link copied to clipboard
class VolumeReplication : KotlinCustomResource
Link copied to clipboard
data class VolumeReplicationArgs(val deleteDestinationVolume: Output<Boolean>? = null, val description: Output<String>? = null, val destinationVolumeParameters: Output<VolumeReplicationDestinationVolumeParametersArgs>? = null, val forceStopping: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val replicationEnabled: Output<Boolean>? = null, val replicationSchedule: Output<String>? = null, val volumeName: Output<String>? = null, val waitForMirror: Output<Boolean>? = null) : ConvertibleToJava<VolumeReplicationArgs>
Link copied to clipboard
object VolumeReplicationMapper : ResourceMapper<VolumeReplication>
Link copied to clipboard

Builder for Volume.

Link copied to clipboard
class VolumeSnapshot : KotlinCustomResource

NetApp Volumes helps you manage your data usage with snapshots that can quickly restore lost data. Snapshots are point-in-time versions of your volume's content. They are resources of volumes and are instant captures of your data that consume space only for modified data. Because data changes over time, snapshots usually consume more space as they get older. NetApp Volumes volumes use just-in-time copy-on-write so that unmodified files in snapshots don't consume any of the volume's capacity. To get more information about VolumeSnapshot, see:

Link copied to clipboard
data class VolumeSnapshotArgs(val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val volumeName: Output<String>? = null) : ConvertibleToJava<VolumeSnapshotArgs>

NetApp Volumes helps you manage your data usage with snapshots that can quickly restore lost data. Snapshots are point-in-time versions of your volume's content. They are resources of volumes and are instant captures of your data that consume space only for modified data. Because data changes over time, snapshots usually consume more space as they get older. NetApp Volumes volumes use just-in-time copy-on-write so that unmodified files in snapshots don't consume any of the volume's capacity. To get more information about VolumeSnapshot, see:

Link copied to clipboard
Link copied to clipboard
object VolumeSnapshotMapper : ResourceMapper<VolumeSnapshot>

Functions

Link copied to clipboard
Link copied to clipboard
fun backup(name: String): Backup
suspend fun backup(name: String, block: suspend BackupResourceBuilder.() -> Unit): Backup
Link copied to clipboard
Link copied to clipboard
suspend fun backupVault(name: String, block: suspend BackupVaultResourceBuilder.() -> Unit): BackupVault
Link copied to clipboard
suspend fun kmsconfig(name: String, block: suspend KmsconfigResourceBuilder.() -> Unit): Kmsconfig
Link copied to clipboard
suspend fun storagePool(name: String, block: suspend StoragePoolResourceBuilder.() -> Unit): StoragePool
Link copied to clipboard
fun volume(name: String): Volume
suspend fun volume(name: String, block: suspend VolumeResourceBuilder.() -> Unit): Volume
Link copied to clipboard
Link copied to clipboard