com.pulumi.azure.iot.kotlin.inputs.IoTHubFileUploadArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.14.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.iot.kotlin.inputs

import com.pulumi.azure.iot.inputs.IoTHubFileUploadArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property authenticationType The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
 * @property connectionString The connection string for the Azure Storage account to which files are uploaded.
 * @property containerName The name of the root container where the files should be uploaded to. The container need not exist but should be creatable using the connection_string specified.
 * @property defaultTtl The period of time for which a file upload notification message is available to consume before it expires, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 48 hours. Defaults to `PT1H`.
 * @property identityId The ID of the User Managed Identity used to authenticate against the storage account.
 * > **NOTE:** `identity_id` can only be specified when `authentication_type` is `identityBased`. It must be one of the `identity_ids` of the IoT Hub. If `identity_id` is omitted when `authentication_type` is `identityBased`, then the System-Assigned Managed Identity of the IoT Hub will be used.
 * > **NOTE:** An IoT Hub can only be updated to use the System-Assigned Managed Identity for `file_upload` since it is not possible to grant access to the endpoint until after creation.
 * @property lockDuration The lock duration for the file upload notifications queue, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 5 and 300 seconds. Defaults to `PT1M`.
 * @property maxDeliveryCount The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
 * @property notifications Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
 * @property sasTtl The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 24 hours. Defaults to `PT1H`.
 */
public data class IoTHubFileUploadArgs(
    public val authenticationType: Output? = null,
    public val connectionString: Output,
    public val containerName: Output,
    public val defaultTtl: Output? = null,
    public val identityId: Output? = null,
    public val lockDuration: Output? = null,
    public val maxDeliveryCount: Output? = null,
    public val notifications: Output? = null,
    public val sasTtl: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.iot.inputs.IoTHubFileUploadArgs =
        com.pulumi.azure.iot.inputs.IoTHubFileUploadArgs.builder()
            .authenticationType(authenticationType?.applyValue({ args0 -> args0 }))
            .connectionString(connectionString.applyValue({ args0 -> args0 }))
            .containerName(containerName.applyValue({ args0 -> args0 }))
            .defaultTtl(defaultTtl?.applyValue({ args0 -> args0 }))
            .identityId(identityId?.applyValue({ args0 -> args0 }))
            .lockDuration(lockDuration?.applyValue({ args0 -> args0 }))
            .maxDeliveryCount(maxDeliveryCount?.applyValue({ args0 -> args0 }))
            .notifications(notifications?.applyValue({ args0 -> args0 }))
            .sasTtl(sasTtl?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [IoTHubFileUploadArgs].
 */
@PulumiTagMarker
public class IoTHubFileUploadArgsBuilder internal constructor() {
    private var authenticationType: Output? = null

    private var connectionString: Output? = null

    private var containerName: Output? = null

    private var defaultTtl: Output? = null

    private var identityId: Output? = null

    private var lockDuration: Output? = null

    private var maxDeliveryCount: Output? = null

    private var notifications: Output? = null

    private var sasTtl: Output? = null

    /**
     * @param value The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
     */
    @JvmName("ljplhhnxobfksfvf")
    public suspend fun authenticationType(`value`: Output) {
        this.authenticationType = value
    }

    /**
     * @param value The connection string for the Azure Storage account to which files are uploaded.
     */
    @JvmName("pelhxleitcqvcfuq")
    public suspend fun connectionString(`value`: Output) {
        this.connectionString = value
    }

    /**
     * @param value The name of the root container where the files should be uploaded to. The container need not exist but should be creatable using the connection_string specified.
     */
    @JvmName("kwxsoprrootqbbpv")
    public suspend fun containerName(`value`: Output) {
        this.containerName = value
    }

    /**
     * @param value The period of time for which a file upload notification message is available to consume before it expires, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 48 hours. Defaults to `PT1H`.
     */
    @JvmName("rejdohdxwhsgqqnh")
    public suspend fun defaultTtl(`value`: Output) {
        this.defaultTtl = value
    }

    /**
     * @param value The ID of the User Managed Identity used to authenticate against the storage account.
     * > **NOTE:** `identity_id` can only be specified when `authentication_type` is `identityBased`. It must be one of the `identity_ids` of the IoT Hub. If `identity_id` is omitted when `authentication_type` is `identityBased`, then the System-Assigned Managed Identity of the IoT Hub will be used.
     * > **NOTE:** An IoT Hub can only be updated to use the System-Assigned Managed Identity for `file_upload` since it is not possible to grant access to the endpoint until after creation.
     */
    @JvmName("dhikyfbafeglohvs")
    public suspend fun identityId(`value`: Output) {
        this.identityId = value
    }

    /**
     * @param value The lock duration for the file upload notifications queue, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 5 and 300 seconds. Defaults to `PT1M`.
     */
    @JvmName("nftfqhaexhxdtdbu")
    public suspend fun lockDuration(`value`: Output) {
        this.lockDuration = value
    }

    /**
     * @param value The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
     */
    @JvmName("vogyushwkvfbguqv")
    public suspend fun maxDeliveryCount(`value`: Output) {
        this.maxDeliveryCount = value
    }

    /**
     * @param value Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
     */
    @JvmName("klsjgahdifvcfgwr")
    public suspend fun notifications(`value`: Output) {
        this.notifications = value
    }

    /**
     * @param value The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 24 hours. Defaults to `PT1H`.
     */
    @JvmName("ahxfmdaaekddstjc")
    public suspend fun sasTtl(`value`: Output) {
        this.sasTtl = value
    }

    /**
     * @param value The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
     */
    @JvmName("bbbtqkojbavhxtpb")
    public suspend fun authenticationType(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.authenticationType = mapped
    }

    /**
     * @param value The connection string for the Azure Storage account to which files are uploaded.
     */
    @JvmName("acrcdmqncepnrshb")
    public suspend fun connectionString(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.connectionString = mapped
    }

    /**
     * @param value The name of the root container where the files should be uploaded to. The container need not exist but should be creatable using the connection_string specified.
     */
    @JvmName("qgafbtxrgubpbrwk")
    public suspend fun containerName(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.containerName = mapped
    }

    /**
     * @param value The period of time for which a file upload notification message is available to consume before it expires, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 48 hours. Defaults to `PT1H`.
     */
    @JvmName("ptgckymbejiehrwx")
    public suspend fun defaultTtl(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.defaultTtl = mapped
    }

    /**
     * @param value The ID of the User Managed Identity used to authenticate against the storage account.
     * > **NOTE:** `identity_id` can only be specified when `authentication_type` is `identityBased`. It must be one of the `identity_ids` of the IoT Hub. If `identity_id` is omitted when `authentication_type` is `identityBased`, then the System-Assigned Managed Identity of the IoT Hub will be used.
     * > **NOTE:** An IoT Hub can only be updated to use the System-Assigned Managed Identity for `file_upload` since it is not possible to grant access to the endpoint until after creation.
     */
    @JvmName("qsgyahkpkhenmwmn")
    public suspend fun identityId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.identityId = mapped
    }

    /**
     * @param value The lock duration for the file upload notifications queue, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 5 and 300 seconds. Defaults to `PT1M`.
     */
    @JvmName("mxwkbswgjxvhtdre")
    public suspend fun lockDuration(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.lockDuration = mapped
    }

    /**
     * @param value The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
     */
    @JvmName("pklbjgvncljecyvk")
    public suspend fun maxDeliveryCount(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxDeliveryCount = mapped
    }

    /**
     * @param value Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
     */
    @JvmName("oryykgmhluyoclbt")
    public suspend fun notifications(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.notifications = mapped
    }

    /**
     * @param value The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an [ISO 8601 timespan duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This value must be between 1 minute and 24 hours. Defaults to `PT1H`.
     */
    @JvmName("bwdpgctcxswvuhqq")
    public suspend fun sasTtl(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sasTtl = mapped
    }

    internal fun build(): IoTHubFileUploadArgs = IoTHubFileUploadArgs(
        authenticationType = authenticationType,
        connectionString = connectionString ?: throw PulumiNullFieldException("connectionString"),
        containerName = containerName ?: throw PulumiNullFieldException("containerName"),
        defaultTtl = defaultTtl,
        identityId = identityId,
        lockDuration = lockDuration,
        maxDeliveryCount = maxDeliveryCount,
        notifications = notifications,
        sasTtl = sasTtl,
    )
}