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

StoredIscsiVolume

class StoredIscsiVolume : KotlinCustomResource

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());
    }
}

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());
    }
}

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

Properties

arn

val arn: Output<String>

Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

chapEnabled

val chapEnabled: Output<Boolean>

Whether mutual CHAP is enabled for the iSCSI target.

diskId

val diskId: Output<String>

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

gatewayArn

val gatewayArn: Output<String>

The Amazon Resource Name (ARN) of the gateway.

val id: Output<String>

kmsEncrypted

val kmsEncrypted: Output<Boolean>?

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.

kmsKey

val kmsKey: Output<String>?

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.

lunNumber

val lunNumber: Output<Int>

Logical disk number.

networkInterfaceId

val networkInterfaceId: Output<String>

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

networkInterfacePort

val networkInterfacePort: Output<Int>

The port used to communicate with iSCSI targets.

preserveExistingData

val preserveExistingData: Output<Boolean>

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.