com.pulumi.awsnative.efs.kotlin.FileSystemArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.efs.kotlin
import com.pulumi.awsnative.efs.FileSystemArgs.builder
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemBackupPolicyArgs
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemBackupPolicyArgsBuilder
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemLifecyclePolicyArgs
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemLifecyclePolicyArgsBuilder
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemProtectionArgs
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemProtectionArgsBuilder
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemReplicationConfigurationArgs
import com.pulumi.awsnative.efs.kotlin.inputs.FileSystemReplicationConfigurationArgsBuilder
import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Any
import kotlin.Boolean
import kotlin.Double
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
* @property availabilityZoneName For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
* One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
* @property backupPolicy Use the ``BackupPolicy`` to turn automatic backups on or off for the file system.
* @property bypassPolicyLockoutSafetyCheck (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.
* @property encrypted A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.
* @property fileSystemPolicy The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::EFS::FileSystem` for more information about the expected schema for this property.
* @property fileSystemProtection Describes the protection on the file system.
* @property fileSystemTags Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
* @property kmsKeyId The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
* + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.
* + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.
* + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.
* + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.
* If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
* @property lifecyclePolicies An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
* @property performanceMode The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.
* Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
* Default is ``generalPurpose``.
* @property provisionedThroughputInMibps The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
* @property replicationConfiguration Describes the replication configuration for a specific file system.
* @property throughputMode Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
* Default is ``bursting``.
*/
public data class FileSystemArgs(
public val availabilityZoneName: Output? = null,
public val backupPolicy: Output? = null,
public val bypassPolicyLockoutSafetyCheck: Output? = null,
public val encrypted: Output? = null,
public val fileSystemPolicy: Output? = null,
public val fileSystemProtection: Output? = null,
public val fileSystemTags: Output>? = null,
public val kmsKeyId: Output? = null,
public val lifecyclePolicies: Output>? = null,
public val performanceMode: Output? = null,
public val provisionedThroughputInMibps: Output? = null,
public val replicationConfiguration: Output? = null,
public val throughputMode: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.efs.FileSystemArgs =
com.pulumi.awsnative.efs.FileSystemArgs.builder()
.availabilityZoneName(availabilityZoneName?.applyValue({ args0 -> args0 }))
.backupPolicy(backupPolicy?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.bypassPolicyLockoutSafetyCheck(bypassPolicyLockoutSafetyCheck?.applyValue({ args0 -> args0 }))
.encrypted(encrypted?.applyValue({ args0 -> args0 }))
.fileSystemPolicy(fileSystemPolicy?.applyValue({ args0 -> args0 }))
.fileSystemProtection(
fileSystemProtection?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.fileSystemTags(
fileSystemTags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.kmsKeyId(kmsKeyId?.applyValue({ args0 -> args0 }))
.lifecyclePolicies(
lifecyclePolicies?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.performanceMode(performanceMode?.applyValue({ args0 -> args0 }))
.provisionedThroughputInMibps(provisionedThroughputInMibps?.applyValue({ args0 -> args0 }))
.replicationConfiguration(
replicationConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.throughputMode(throughputMode?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [FileSystemArgs].
*/
@PulumiTagMarker
public class FileSystemArgsBuilder internal constructor() {
private var availabilityZoneName: Output? = null
private var backupPolicy: Output? = null
private var bypassPolicyLockoutSafetyCheck: Output? = null
private var encrypted: Output? = null
private var fileSystemPolicy: Output? = null
private var fileSystemProtection: Output? = null
private var fileSystemTags: Output>? = null
private var kmsKeyId: Output? = null
private var lifecyclePolicies: Output>? = null
private var performanceMode: Output? = null
private var provisionedThroughputInMibps: Output? = null
private var replicationConfiguration: Output? = null
private var throughputMode: Output? = null
/**
* @param value For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
* One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
*/
@JvmName("giugovxycjexkjap")
public suspend fun availabilityZoneName(`value`: Output) {
this.availabilityZoneName = value
}
/**
* @param value Use the ``BackupPolicy`` to turn automatic backups on or off for the file system.
*/
@JvmName("irdjrawjmpnhcfcn")
public suspend fun backupPolicy(`value`: Output) {
this.backupPolicy = value
}
/**
* @param value (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.
*/
@JvmName("lejfbwluuinxmkeg")
public suspend fun bypassPolicyLockoutSafetyCheck(`value`: Output) {
this.bypassPolicyLockoutSafetyCheck = value
}
/**
* @param value A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.
*/
@JvmName("sfwigamvsacrjbjm")
public suspend fun encrypted(`value`: Output) {
this.encrypted = value
}
/**
* @param value The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::EFS::FileSystem` for more information about the expected schema for this property.
*/
@JvmName("jrwlgagatojuvhus")
public suspend fun fileSystemPolicy(`value`: Output) {
this.fileSystemPolicy = value
}
/**
* @param value Describes the protection on the file system.
*/
@JvmName("gweqxdvyrpnhwwrj")
public suspend fun fileSystemProtection(`value`: Output) {
this.fileSystemProtection = value
}
/**
* @param value Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("xkplwroobtlaagdw")
public suspend fun fileSystemTags(`value`: Output>) {
this.fileSystemTags = value
}
@JvmName("uwgpyukrqohtyhcl")
public suspend fun fileSystemTags(vararg values: Output) {
this.fileSystemTags = Output.all(values.asList())
}
/**
* @param values Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("egbwsniirwaxnegw")
public suspend fun fileSystemTags(values: List>) {
this.fileSystemTags = Output.all(values)
}
/**
* @param value The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
* + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.
* + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.
* + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.
* + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.
* If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
*/
@JvmName("mnwcmnutrncwppry")
public suspend fun kmsKeyId(`value`: Output) {
this.kmsKeyId = value
}
/**
* @param value An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("bwxsuaxlrgmtbbyv")
public suspend fun lifecyclePolicies(`value`: Output>) {
this.lifecyclePolicies = value
}
@JvmName("qaxwkfurwmklmrlp")
public suspend fun lifecyclePolicies(vararg values: Output) {
this.lifecyclePolicies = Output.all(values.asList())
}
/**
* @param values An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("lqcaugjlwmptykiy")
public suspend fun lifecyclePolicies(values: List>) {
this.lifecyclePolicies = Output.all(values)
}
/**
* @param value The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.
* Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
* Default is ``generalPurpose``.
*/
@JvmName("amknrdkwteydlsub")
public suspend fun performanceMode(`value`: Output) {
this.performanceMode = value
}
/**
* @param value The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
*/
@JvmName("mftwniyxvnxaupwj")
public suspend fun provisionedThroughputInMibps(`value`: Output) {
this.provisionedThroughputInMibps = value
}
/**
* @param value Describes the replication configuration for a specific file system.
*/
@JvmName("raamssbfrvgreceb")
public suspend fun replicationConfiguration(`value`: Output) {
this.replicationConfiguration = value
}
/**
* @param value Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
* Default is ``bursting``.
*/
@JvmName("rsvgeolchnafqdgu")
public suspend fun throughputMode(`value`: Output) {
this.throughputMode = value
}
/**
* @param value For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
* One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
*/
@JvmName("hdceqhixvloiokxe")
public suspend fun availabilityZoneName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.availabilityZoneName = mapped
}
/**
* @param value Use the ``BackupPolicy`` to turn automatic backups on or off for the file system.
*/
@JvmName("yryqqabtjprmxuku")
public suspend fun backupPolicy(`value`: FileSystemBackupPolicyArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.backupPolicy = mapped
}
/**
* @param argument Use the ``BackupPolicy`` to turn automatic backups on or off for the file system.
*/
@JvmName("gybxbmiklbsboylc")
public suspend fun backupPolicy(argument: suspend FileSystemBackupPolicyArgsBuilder.() -> Unit) {
val toBeMapped = FileSystemBackupPolicyArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.backupPolicy = mapped
}
/**
* @param value (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.
*/
@JvmName("amlhcpysswbjyquw")
public suspend fun bypassPolicyLockoutSafetyCheck(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.bypassPolicyLockoutSafetyCheck = mapped
}
/**
* @param value A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.
*/
@JvmName("cymuygphoihxwarc")
public suspend fun encrypted(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.encrypted = mapped
}
/**
* @param value The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::EFS::FileSystem` for more information about the expected schema for this property.
*/
@JvmName("scigenmwhbxdibmo")
public suspend fun fileSystemPolicy(`value`: Any?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.fileSystemPolicy = mapped
}
/**
* @param value Describes the protection on the file system.
*/
@JvmName("tvigblqfgdcuxjfh")
public suspend fun fileSystemProtection(`value`: FileSystemProtectionArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.fileSystemProtection = mapped
}
/**
* @param argument Describes the protection on the file system.
*/
@JvmName("oggyjjfcvawegoaf")
public suspend fun fileSystemProtection(argument: suspend FileSystemProtectionArgsBuilder.() -> Unit) {
val toBeMapped = FileSystemProtectionArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.fileSystemProtection = mapped
}
/**
* @param value Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("ikwadwtjaesttmnn")
public suspend fun fileSystemTags(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.fileSystemTags = mapped
}
/**
* @param argument Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("lwdpjvmodoldgaoa")
public suspend fun fileSystemTags(argument: List Unit>) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.fileSystemTags = mapped
}
/**
* @param argument Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("vlyjjyysgviuobux")
public suspend fun fileSystemTags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.fileSystemTags = mapped
}
/**
* @param argument Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("iyxanskmsnlqxpgs")
public suspend fun fileSystemTags(argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.fileSystemTags = mapped
}
/**
* @param values Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
*/
@JvmName("mgwxorqolgdcxlpf")
public suspend fun fileSystemTags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.fileSystemTags = mapped
}
/**
* @param value The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
* + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.
* + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.
* + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.
* + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.
* If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
*/
@JvmName("kwsvsguvyiilldlp")
public suspend fun kmsKeyId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.kmsKeyId = mapped
}
/**
* @param value An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("tywswfexkidaxebs")
public suspend fun lifecyclePolicies(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.lifecyclePolicies = mapped
}
/**
* @param argument An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("lkqyrdaixhbtfkor")
public suspend fun lifecyclePolicies(argument: List Unit>) {
val toBeMapped = argument.toList().map {
FileSystemLifecyclePolicyArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.lifecyclePolicies = mapped
}
/**
* @param argument An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("hoadcucavefdtuqx")
public suspend fun lifecyclePolicies(vararg argument: suspend FileSystemLifecyclePolicyArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
FileSystemLifecyclePolicyArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.lifecyclePolicies = mapped
}
/**
* @param argument An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("micmcgnpqytrqhcw")
public suspend fun lifecyclePolicies(argument: suspend FileSystemLifecyclePolicyArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
FileSystemLifecyclePolicyArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.lifecyclePolicies = mapped
}
/**
* @param values An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
* + When to move files in the file system from primary storage to IA storage.
* + When to move files in the file system from primary storage or IA storage to Archive storage.
* + When to move files that are in IA or Archive storage to primary storage.
* EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
*/
@JvmName("bkspyugtqmxqcdjt")
public suspend fun lifecyclePolicies(vararg values: FileSystemLifecyclePolicyArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.lifecyclePolicies = mapped
}
/**
* @param value The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.
* Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
* Default is ``generalPurpose``.
*/
@JvmName("qdaggvrcitbatwwh")
public suspend fun performanceMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.performanceMode = mapped
}
/**
* @param value The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
*/
@JvmName("cbpvdvqegoxwhytr")
public suspend fun provisionedThroughputInMibps(`value`: Double?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.provisionedThroughputInMibps = mapped
}
/**
* @param value Describes the replication configuration for a specific file system.
*/
@JvmName("aqukqoboaxutnqls")
public suspend fun replicationConfiguration(`value`: FileSystemReplicationConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicationConfiguration = mapped
}
/**
* @param argument Describes the replication configuration for a specific file system.
*/
@JvmName("kimagwsofuxrrudo")
public suspend fun replicationConfiguration(argument: suspend FileSystemReplicationConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = FileSystemReplicationConfigurationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.replicationConfiguration = mapped
}
/**
* @param value Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
* Default is ``bursting``.
*/
@JvmName("urxwhufkgwbqucsc")
public suspend fun throughputMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.throughputMode = mapped
}
internal fun build(): FileSystemArgs = FileSystemArgs(
availabilityZoneName = availabilityZoneName,
backupPolicy = backupPolicy,
bypassPolicyLockoutSafetyCheck = bypassPolicyLockoutSafetyCheck,
encrypted = encrypted,
fileSystemPolicy = fileSystemPolicy,
fileSystemProtection = fileSystemProtection,
fileSystemTags = fileSystemTags,
kmsKeyId = kmsKeyId,
lifecyclePolicies = lifecyclePolicies,
performanceMode = performanceMode,
provisionedThroughputInMibps = provisionedThroughputInMibps,
replicationConfiguration = replicationConfiguration,
throughputMode = throughputMode,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy