com.pulumi.azure.iot.inputs.IoTHubFileUploadArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.iot.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class IoTHubFileUploadArgs extends com.pulumi.resources.ResourceArgs {
public static final IoTHubFileUploadArgs Empty = new IoTHubFileUploadArgs();
/**
* The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
*/
@Import(name="authenticationType")
private @Nullable Output authenticationType;
/**
* @return The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
*/
public Optional> authenticationType() {
return Optional.ofNullable(this.authenticationType);
}
/**
* The connection string for the Azure Storage account to which files are uploaded.
*
*/
@Import(name="connectionString", required=true)
private Output connectionString;
/**
* @return The connection string for the Azure Storage account to which files are uploaded.
*
*/
public Output connectionString() {
return this.connectionString;
}
/**
* 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.
*
*/
@Import(name="containerName", required=true)
private Output containerName;
/**
* @return 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.
*
*/
public Output containerName() {
return this.containerName;
}
/**
* 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`.
*
*/
@Import(name="defaultTtl")
private @Nullable Output defaultTtl;
/**
* @return 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`.
*
*/
public Optional> defaultTtl() {
return Optional.ofNullable(this.defaultTtl);
}
/**
* 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.
*
*/
@Import(name="identityId")
private @Nullable Output identityId;
/**
* @return 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.
*
*/
public Optional> identityId() {
return Optional.ofNullable(this.identityId);
}
/**
* 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`.
*
*/
@Import(name="lockDuration")
private @Nullable Output lockDuration;
/**
* @return 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`.
*
*/
public Optional> lockDuration() {
return Optional.ofNullable(this.lockDuration);
}
/**
* The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
*
*/
@Import(name="maxDeliveryCount")
private @Nullable Output maxDeliveryCount;
/**
* @return The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
*
*/
public Optional> maxDeliveryCount() {
return Optional.ofNullable(this.maxDeliveryCount);
}
/**
* Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
*
*/
@Import(name="notifications")
private @Nullable Output notifications;
/**
* @return Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
*
*/
public Optional> notifications() {
return Optional.ofNullable(this.notifications);
}
/**
* 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`.
*
*/
@Import(name="sasTtl")
private @Nullable Output sasTtl;
/**
* @return 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 Optional> sasTtl() {
return Optional.ofNullable(this.sasTtl);
}
private IoTHubFileUploadArgs() {}
private IoTHubFileUploadArgs(IoTHubFileUploadArgs $) {
this.authenticationType = $.authenticationType;
this.connectionString = $.connectionString;
this.containerName = $.containerName;
this.defaultTtl = $.defaultTtl;
this.identityId = $.identityId;
this.lockDuration = $.lockDuration;
this.maxDeliveryCount = $.maxDeliveryCount;
this.notifications = $.notifications;
this.sasTtl = $.sasTtl;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(IoTHubFileUploadArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private IoTHubFileUploadArgs $;
public Builder() {
$ = new IoTHubFileUploadArgs();
}
public Builder(IoTHubFileUploadArgs defaults) {
$ = new IoTHubFileUploadArgs(Objects.requireNonNull(defaults));
}
/**
* @param authenticationType The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
* @return builder
*
*/
public Builder authenticationType(@Nullable Output authenticationType) {
$.authenticationType = authenticationType;
return this;
}
/**
* @param authenticationType The type used to authenticate against the storage account. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
* @return builder
*
*/
public Builder authenticationType(String authenticationType) {
return authenticationType(Output.of(authenticationType));
}
/**
* @param connectionString The connection string for the Azure Storage account to which files are uploaded.
*
* @return builder
*
*/
public Builder connectionString(Output connectionString) {
$.connectionString = connectionString;
return this;
}
/**
* @param connectionString The connection string for the Azure Storage account to which files are uploaded.
*
* @return builder
*
*/
public Builder connectionString(String connectionString) {
return connectionString(Output.of(connectionString));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder containerName(Output containerName) {
$.containerName = containerName;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder containerName(String containerName) {
return containerName(Output.of(containerName));
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder defaultTtl(@Nullable Output defaultTtl) {
$.defaultTtl = defaultTtl;
return this;
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder defaultTtl(String defaultTtl) {
return defaultTtl(Output.of(defaultTtl));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder identityId(@Nullable Output identityId) {
$.identityId = identityId;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder identityId(String identityId) {
return identityId(Output.of(identityId));
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder lockDuration(@Nullable Output lockDuration) {
$.lockDuration = lockDuration;
return this;
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder lockDuration(String lockDuration) {
return lockDuration(Output.of(lockDuration));
}
/**
* @param maxDeliveryCount The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
*
* @return builder
*
*/
public Builder maxDeliveryCount(@Nullable Output maxDeliveryCount) {
$.maxDeliveryCount = maxDeliveryCount;
return this;
}
/**
* @param maxDeliveryCount The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to `10`.
*
* @return builder
*
*/
public Builder maxDeliveryCount(Integer maxDeliveryCount) {
return maxDeliveryCount(Output.of(maxDeliveryCount));
}
/**
* @param notifications Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
*
* @return builder
*
*/
public Builder notifications(@Nullable Output notifications) {
$.notifications = notifications;
return this;
}
/**
* @param notifications Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to `false`.
*
* @return builder
*
*/
public Builder notifications(Boolean notifications) {
return notifications(Output.of(notifications));
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder sasTtl(@Nullable Output sasTtl) {
$.sasTtl = sasTtl;
return this;
}
/**
* @param 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`.
*
* @return builder
*
*/
public Builder sasTtl(String sasTtl) {
return sasTtl(Output.of(sasTtl));
}
public IoTHubFileUploadArgs build() {
if ($.connectionString == null) {
throw new MissingRequiredPropertyException("IoTHubFileUploadArgs", "connectionString");
}
if ($.containerName == null) {
throw new MissingRequiredPropertyException("IoTHubFileUploadArgs", "containerName");
}
return $;
}
}
}