pulumi-aws-kotlin/com.pulumi.aws.storagegateway.kotlin/StoredIscsiVolumeArgs

StoredIscsiVolumeArgs

data class StoredIscsiVolumeArgs(val diskId: Output<String>? = null, val gatewayArn: Output<String>? = null, val kmsEncrypted: Output<Boolean>? = null, val kmsKey: Output<String>? = null, val networkInterfaceId: Output<String>? = null, val preserveExistingData: Output<Boolean>? = null, val snapshotId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val targetName: Output<String>? = null) : ConvertibleToJava<StoredIscsiVolumeArgs>

Manages an AWS Storage Gateway stored iSCSI volume.

NOTE: The gateway must have a working storage added (e.g., via the aws.storagegateway.WorkingStorage resource) before the volume is operational to clients, however the Storage Gateway API will allow volume creation without error in that case and return volume status as WORKING STORAGE NOT CONFIGURED.

Example Usage

Create Empty Stored iSCSI Volume

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.StoredIscsiVolume;
import com.pulumi.aws.storagegateway.StoredIscsiVolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new StoredIscsiVolume("example", StoredIscsiVolumeArgs.builder()
            .gatewayArn(aws_storagegateway_cache.example().gateway_arn())
            .networkInterfaceId(aws_instance.example().private_ip())
            .targetName("example")
            .preserveExistingData(false)
            .diskId(data.aws_storagegateway_local_disk().test().id())
            .build());
    }
}
Content copied to clipboard

Create Stored iSCSI Volume From Snapshot

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.StoredIscsiVolume;
import com.pulumi.aws.storagegateway.StoredIscsiVolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new StoredIscsiVolume("example", StoredIscsiVolumeArgs.builder()
            .gatewayArn(aws_storagegateway_cache.example().gateway_arn())
            .networkInterfaceId(aws_instance.example().private_ip())
            .snapshotId(aws_ebs_snapshot.example().id())
            .targetName("example")
            .preserveExistingData(false)
            .diskId(data.aws_storagegateway_local_disk().test().id())
            .build());
    }
}
Content copied to clipboard

Import

aws_storagegateway_stored_iscsi_volume can be imported by using the volume Amazon Resource Name (ARN), e.g.,

$ pulumi import aws:storagegateway/storedIscsiVolume:StoredIscsiVolume example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(diskId: Output<String>? = null, gatewayArn: Output<String>? = null, kmsEncrypted: Output<Boolean>? = null, kmsKey: Output<String>? = null, networkInterfaceId: Output<String>? = null, preserveExistingData: Output<Boolean>? = null, snapshotId: Output<String>? = null, tags: Output<Map<String, String>>? = null, targetName: Output<String>? = null)

Properties

Link copied to clipboard
val diskId: Output<String>? = null

The unique identifier for the gateway local disk that is configured as a stored volume.

Link copied to clipboard
val gatewayArn: Output<String>? = null

The Amazon Resource Name (ARN) of the gateway.

Link copied to clipboard
val kmsEncrypted: Output<Boolean>? = null

true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Link copied to clipboard
val kmsKey: Output<String>? = null

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.

Link copied to clipboard
val networkInterfaceId: Output<String>? = null

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

Link copied to clipboard
val preserveExistingData: Output<Boolean>? = null

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Link copied to clipboard
val snapshotId: Output<String>? = null

The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value mapping of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val targetName: Output<String>? = null

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway.

Functions

Link copied to clipboard
open override fun toJava(): StoredIscsiVolumeArgs