Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. storagegateway
  5. StoredIscsiVolume
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

aws.storagegateway.StoredIscsiVolume

Explore with Pulumi AI

aws logo
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.StoredIscsiVolume("example", {
    gatewayArn: exampleAwsStoragegatewayCache.gatewayArn,
    networkInterfaceId: exampleAwsInstance.privateIp,
    targetName: "example",
    preserveExistingData: false,
    diskId: test.id,
});

    import pulumi
import pulumi_aws as aws

example = aws.storagegateway.StoredIscsiVolume("example",
    gateway_arn=example_aws_storagegateway_cache["gatewayArn"],
    network_interface_id=example_aws_instance["privateIp"],
    target_name="example",
    preserve_existing_data=False,
    disk_id=test["id"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewStoredIscsiVolume(ctx, "example", &storagegateway.StoredIscsiVolumeArgs{
			GatewayArn:           pulumi.Any(exampleAwsStoragegatewayCache.GatewayArn),
			NetworkInterfaceId:   pulumi.Any(exampleAwsInstance.PrivateIp),
			TargetName:           pulumi.String("example"),
			PreserveExistingData: pulumi.Bool(false),
			DiskId:               pulumi.Any(test.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.StoredIscsiVolume("example", new()
    {
        GatewayArn = exampleAwsStoragegatewayCache.GatewayArn,
        NetworkInterfaceId = exampleAwsInstance.PrivateIp,
        TargetName = "example",
        PreserveExistingData = false,
        DiskId = test.Id,
    });

});

    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(exampleAwsStoragegatewayCache.gatewayArn())
            .networkInterfaceId(exampleAwsInstance.privateIp())
            .targetName("example")
            .preserveExistingData(false)
            .diskId(test.id())
            .build());

    }
}

    resources:
  example:
    type: aws:storagegateway:StoredIscsiVolume
    properties:
      gatewayArn: ${exampleAwsStoragegatewayCache.gatewayArn}
      networkInterfaceId: ${exampleAwsInstance.privateIp}
      targetName: example
      preserveExistingData: false
      diskId: ${test.id}

    Create Stored iSCSI Volume From Snapshot

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.StoredIscsiVolume("example", {
    gatewayArn: exampleAwsStoragegatewayCache.gatewayArn,
    networkInterfaceId: exampleAwsInstance.privateIp,
    snapshotId: exampleAwsEbsSnapshot.id,
    targetName: "example",
    preserveExistingData: false,
    diskId: test.id,
});

    import pulumi
import pulumi_aws as aws

example = aws.storagegateway.StoredIscsiVolume("example",
    gateway_arn=example_aws_storagegateway_cache["gatewayArn"],
    network_interface_id=example_aws_instance["privateIp"],
    snapshot_id=example_aws_ebs_snapshot["id"],
    target_name="example",
    preserve_existing_data=False,
    disk_id=test["id"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewStoredIscsiVolume(ctx, "example", &storagegateway.StoredIscsiVolumeArgs{
			GatewayArn:           pulumi.Any(exampleAwsStoragegatewayCache.GatewayArn),
			NetworkInterfaceId:   pulumi.Any(exampleAwsInstance.PrivateIp),
			SnapshotId:           pulumi.Any(exampleAwsEbsSnapshot.Id),
			TargetName:           pulumi.String("example"),
			PreserveExistingData: pulumi.Bool(false),
			DiskId:               pulumi.Any(test.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.StoredIscsiVolume("example", new()
    {
        GatewayArn = exampleAwsStoragegatewayCache.GatewayArn,
        NetworkInterfaceId = exampleAwsInstance.PrivateIp,
        SnapshotId = exampleAwsEbsSnapshot.Id,
        TargetName = "example",
        PreserveExistingData = false,
        DiskId = test.Id,
    });

});

    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(exampleAwsStoragegatewayCache.gatewayArn())
            .networkInterfaceId(exampleAwsInstance.privateIp())
            .snapshotId(exampleAwsEbsSnapshot.id())
            .targetName("example")
            .preserveExistingData(false)
            .diskId(test.id())
            .build());

    }
}

    resources:
  example:
    type: aws:storagegateway:StoredIscsiVolume
    properties:
      gatewayArn: ${exampleAwsStoragegatewayCache.gatewayArn}
      networkInterfaceId: ${exampleAwsInstance.privateIp}
      snapshotId: ${exampleAwsEbsSnapshot.id}
      targetName: example
      preserveExistingData: false
      diskId: ${test.id}

    Create StoredIscsiVolume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StoredIscsiVolume(name: string, args: StoredIscsiVolumeArgs, opts?: CustomResourceOptions);
    @overload
def StoredIscsiVolume(resource_name: str,
                      args: StoredIscsiVolumeArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def StoredIscsiVolume(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      disk_id: Optional[str] = None,
                      gateway_arn: Optional[str] = None,
                      network_interface_id: Optional[str] = None,
                      preserve_existing_data: Optional[bool] = None,
                      target_name: Optional[str] = None,
                      kms_encrypted: Optional[bool] = None,
                      kms_key: Optional[str] = None,
                      snapshot_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewStoredIscsiVolume(ctx *Context, name string, args StoredIscsiVolumeArgs, opts ...ResourceOption) (*StoredIscsiVolume, error)
    public StoredIscsiVolume(string name, StoredIscsiVolumeArgs args, CustomResourceOptions? opts = null)
    public StoredIscsiVolume(String name, StoredIscsiVolumeArgs args)
public StoredIscsiVolume(String name, StoredIscsiVolumeArgs args, CustomResourceOptions options)

    type: aws:storagegateway:StoredIscsiVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StoredIscsiVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StoredIscsiVolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StoredIscsiVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StoredIscsiVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StoredIscsiVolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var storedIscsiVolumeResource = new Aws.StorageGateway.StoredIscsiVolume("storedIscsiVolumeResource", new()
{
    DiskId = "string",
    GatewayArn = "string",
    NetworkInterfaceId = "string",
    PreserveExistingData = false,
    TargetName = "string",
    KmsEncrypted = false,
    KmsKey = "string",
    SnapshotId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := storagegateway.NewStoredIscsiVolume(ctx, "storedIscsiVolumeResource", &storagegateway.StoredIscsiVolumeArgs{
	DiskId:               pulumi.String("string"),
	GatewayArn:           pulumi.String("string"),
	NetworkInterfaceId:   pulumi.String("string"),
	PreserveExistingData: pulumi.Bool(false),
	TargetName:           pulumi.String("string"),
	KmsEncrypted:         pulumi.Bool(false),
	KmsKey:               pulumi.String("string"),
	SnapshotId:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var storedIscsiVolumeResource = new StoredIscsiVolume("storedIscsiVolumeResource", StoredIscsiVolumeArgs.builder()
    .diskId("string")
    .gatewayArn("string")
    .networkInterfaceId("string")
    .preserveExistingData(false)
    .targetName("string")
    .kmsEncrypted(false)
    .kmsKey("string")
    .snapshotId("string")
    .tags(Map.of("string", "string"))
    .build());

    stored_iscsi_volume_resource = aws.storagegateway.StoredIscsiVolume("storedIscsiVolumeResource",
    disk_id="string",
    gateway_arn="string",
    network_interface_id="string",
    preserve_existing_data=False,
    target_name="string",
    kms_encrypted=False,
    kms_key="string",
    snapshot_id="string",
    tags={
        "string": "string",
    })

    const storedIscsiVolumeResource = new aws.storagegateway.StoredIscsiVolume("storedIscsiVolumeResource", {
    diskId: "string",
    gatewayArn: "string",
    networkInterfaceId: "string",
    preserveExistingData: false,
    targetName: "string",
    kmsEncrypted: false,
    kmsKey: "string",
    snapshotId: "string",
    tags: {
        string: "string",
    },
});

    type: aws:storagegateway:StoredIscsiVolume
properties:
    diskId: string
    gatewayArn: string
    kmsEncrypted: false
    kmsKey: string
    networkInterfaceId: string
    preserveExistingData: false
    snapshotId: string
    tags:
        string: string
    targetName: string

    StoredIscsiVolume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StoredIscsiVolume resource accepts the following input properties:

    DiskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    NetworkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    PreserveExistingData bool
    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.
    TargetName string
    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.
    KmsEncrypted bool
    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 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.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    Tags Dictionary<string, string>
    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.
    DiskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    NetworkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    PreserveExistingData bool
    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.
    TargetName string
    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.
    KmsEncrypted bool
    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 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.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    Tags map[string]string
    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.
    diskId String
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    networkInterfaceId String
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    preserveExistingData 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.
    targetName String
    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.
    kmsEncrypted 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 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.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Map<String,String>
    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.
    diskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    networkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    preserveExistingData 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.
    targetName string
    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.
    kmsEncrypted 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 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.
    snapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags {[key: string]: string}
    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.
    disk_id str
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway.
    network_interface_id str
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    preserve_existing_data bool
    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.
    target_name str
    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.
    kms_encrypted bool
    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.
    kms_key str
    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.
    snapshot_id str
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Mapping[str, str]
    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.
    diskId String
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    networkInterfaceId String
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    preserveExistingData 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.
    targetName String
    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.
    kmsEncrypted 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 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.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StoredIscsiVolume resource produces the following output properties:

    Arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    ChapEnabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    Id string
    The provider-assigned unique ID for this managed resource.
    LunNumber int
    Logical disk number.
    NetworkInterfacePort int
    The port used to communicate with iSCSI targets.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    VolumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    VolumeId string
    Volume ID, e.g., vol-12345678.
    VolumeSizeInBytes int
    The size of the data stored on the volume in bytes.
    VolumeStatus string
    indicates the state of the storage volume.
    VolumeType string
    indicates the type of the volume.
    Arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    ChapEnabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    Id string
    The provider-assigned unique ID for this managed resource.
    LunNumber int
    Logical disk number.
    NetworkInterfacePort int
    The port used to communicate with iSCSI targets.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    VolumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    VolumeId string
    Volume ID, e.g., vol-12345678.
    VolumeSizeInBytes int
    The size of the data stored on the volume in bytes.
    VolumeStatus string
    indicates the state of the storage volume.
    VolumeType string
    indicates the type of the volume.
    arn String
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled Boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    id String
    The provider-assigned unique ID for this managed resource.
    lunNumber Integer
    Logical disk number.
    networkInterfacePort Integer
    The port used to communicate with iSCSI targets.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    volumeAttachmentStatus String
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId String
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes Integer
    The size of the data stored on the volume in bytes.
    volumeStatus String
    indicates the state of the storage volume.
    volumeType String
    indicates the type of the volume.
    arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    id string
    The provider-assigned unique ID for this managed resource.
    lunNumber number
    Logical disk number.
    networkInterfacePort number
    The port used to communicate with iSCSI targets.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    volumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId string
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes number
    The size of the data stored on the volume in bytes.
    volumeStatus string
    indicates the state of the storage volume.
    volumeType string
    indicates the type of the volume.
    arn str
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chap_enabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    id str
    The provider-assigned unique ID for this managed resource.
    lun_number int
    Logical disk number.
    network_interface_port int
    The port used to communicate with iSCSI targets.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_arn str
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    volume_attachment_status str
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volume_id str
    Volume ID, e.g., vol-12345678.
    volume_size_in_bytes int
    The size of the data stored on the volume in bytes.
    volume_status str
    indicates the state of the storage volume.
    volume_type str
    indicates the type of the volume.
    arn String
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled Boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    id String
    The provider-assigned unique ID for this managed resource.
    lunNumber Number
    Logical disk number.
    networkInterfacePort Number
    The port used to communicate with iSCSI targets.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    volumeAttachmentStatus String
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId String
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes Number
    The size of the data stored on the volume in bytes.
    volumeStatus String
    indicates the state of the storage volume.
    volumeType String
    indicates the type of the volume.

    Look up Existing StoredIscsiVolume Resource

    Get an existing StoredIscsiVolume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StoredIscsiVolumeState, opts?: CustomResourceOptions): StoredIscsiVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        chap_enabled: Optional[bool] = None,
        disk_id: Optional[str] = None,
        gateway_arn: Optional[str] = None,
        kms_encrypted: Optional[bool] = None,
        kms_key: Optional[str] = None,
        lun_number: Optional[int] = None,
        network_interface_id: Optional[str] = None,
        network_interface_port: Optional[int] = None,
        preserve_existing_data: Optional[bool] = None,
        snapshot_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_arn: Optional[str] = None,
        target_name: Optional[str] = None,
        volume_attachment_status: Optional[str] = None,
        volume_id: Optional[str] = None,
        volume_size_in_bytes: Optional[int] = None,
        volume_status: Optional[str] = None,
        volume_type: Optional[str] = None) -> StoredIscsiVolume
    func GetStoredIscsiVolume(ctx *Context, name string, id IDInput, state *StoredIscsiVolumeState, opts ...ResourceOption) (*StoredIscsiVolume, error)
    public static StoredIscsiVolume Get(string name, Input<string> id, StoredIscsiVolumeState? state, CustomResourceOptions? opts = null)
    public static StoredIscsiVolume get(String name, Output<String> id, StoredIscsiVolumeState state, CustomResourceOptions options)
    resources:  _:    type: aws:storagegateway:StoredIscsiVolume    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    ChapEnabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    DiskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    KmsEncrypted bool
    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 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 int
    Logical disk number.
    NetworkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    NetworkInterfacePort int
    The port used to communicate with iSCSI targets.
    PreserveExistingData bool
    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.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    TargetName string
    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.
    VolumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    VolumeId string
    Volume ID, e.g., vol-12345678.
    VolumeSizeInBytes int
    The size of the data stored on the volume in bytes.
    VolumeStatus string
    indicates the state of the storage volume.
    VolumeType string
    indicates the type of the volume.
    Arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    ChapEnabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    DiskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    KmsEncrypted bool
    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 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 int
    Logical disk number.
    NetworkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    NetworkInterfacePort int
    The port used to communicate with iSCSI targets.
    PreserveExistingData bool
    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.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    TargetName string
    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.
    VolumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    VolumeId string
    Volume ID, e.g., vol-12345678.
    VolumeSizeInBytes int
    The size of the data stored on the volume in bytes.
    VolumeStatus string
    indicates the state of the storage volume.
    VolumeType string
    indicates the type of the volume.
    arn String
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled Boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    diskId String
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    kmsEncrypted 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 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 Integer
    Logical disk number.
    networkInterfaceId String
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    networkInterfacePort Integer
    The port used to communicate with iSCSI targets.
    preserveExistingData 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.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    targetName String
    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.
    volumeAttachmentStatus String
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId String
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes Integer
    The size of the data stored on the volume in bytes.
    volumeStatus String
    indicates the state of the storage volume.
    volumeType String
    indicates the type of the volume.
    arn string
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    diskId string
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    kmsEncrypted 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 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 number
    Logical disk number.
    networkInterfaceId string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    networkInterfacePort number
    The port used to communicate with iSCSI targets.
    preserveExistingData 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.
    snapshotId string
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn string
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    targetName string
    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.
    volumeAttachmentStatus string
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId string
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes number
    The size of the data stored on the volume in bytes.
    volumeStatus string
    indicates the state of the storage volume.
    volumeType string
    indicates the type of the volume.
    arn str
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chap_enabled bool
    Whether mutual CHAP is enabled for the iSCSI target.
    disk_id str
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway.
    kms_encrypted bool
    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.
    kms_key str
    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.
    lun_number int
    Logical disk number.
    network_interface_id str
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    network_interface_port int
    The port used to communicate with iSCSI targets.
    preserve_existing_data bool
    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.
    snapshot_id str
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_arn str
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    target_name str
    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.
    volume_attachment_status str
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volume_id str
    Volume ID, e.g., vol-12345678.
    volume_size_in_bytes int
    The size of the data stored on the volume in bytes.
    volume_status str
    indicates the state of the storage volume.
    volume_type str
    indicates the type of the volume.
    arn String
    Volume Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
    chapEnabled Boolean
    Whether mutual CHAP is enabled for the iSCSI target.
    diskId String
    The unique identifier for the gateway local disk that is configured as a stored volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    kmsEncrypted 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 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 Number
    Logical disk number.
    networkInterfaceId String
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    networkInterfacePort Number
    The port used to communicate with iSCSI targets.
    preserveExistingData 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.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new stored volumeE.g., snap-1122aabb.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    Target Amazon Resource Name (ARN), e.g., arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.
    targetName String
    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.
    volumeAttachmentStatus String
    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
    volumeId String
    Volume ID, e.g., vol-12345678.
    volumeSizeInBytes Number
    The size of the data stored on the volume in bytes.
    volumeStatus String
    indicates the state of the storage volume.
    volumeType String
    indicates the type of the volume.

    Import

    Using pulumi import, import aws_storagegateway_stored_iscsi_volume using the volume Amazon Resource Name (ARN). For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
    pulumi/pulumi-aws