1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. storagegateway
  5. CachesIscsiVolume
aws logo
AWS Classic v5.34.0, Mar 30 23

aws.storagegateway.CachesIscsiVolume

Manages an AWS Storage Gateway cached iSCSI volume.

NOTE: The gateway must have cache added (e.g., via the aws.storagegateway.Cache resource) before creating volumes otherwise the Storage Gateway API will return an error.

NOTE: The gateway must have an upload buffer added (e.g., via the aws.storagegateway.UploadBuffer 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 UPLOAD BUFFER NOT CONFIGURED.

Example Usage

Create Empty Cached iSCSI Volume

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new()
    {
        GatewayArn = aws_storagegateway_cache.Example.Gateway_arn,
        NetworkInterfaceId = aws_instance.Example.Private_ip,
        TargetName = "example",
        VolumeSizeInBytes = 5368709120,
    });

    // 5 GB
});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewCachesIscsiVolume(ctx, "example", &storagegateway.CachesIscsiVolumeArgs{
			GatewayArn:         pulumi.Any(aws_storagegateway_cache.Example.Gateway_arn),
			NetworkInterfaceId: pulumi.Any(aws_instance.Example.Private_ip),
			TargetName:         pulumi.String("example"),
			VolumeSizeInBytes:  pulumi.Int(5368709120),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.CachesIscsiVolume;
import com.pulumi.aws.storagegateway.CachesIscsiVolumeArgs;
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 CachesIscsiVolume("example", CachesIscsiVolumeArgs.builder()        
            .gatewayArn(aws_storagegateway_cache.example().gateway_arn())
            .networkInterfaceId(aws_instance.example().private_ip())
            .targetName("example")
            .volumeSizeInBytes(5368709120)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    target_name="example",
    volume_size_in_bytes=5368709120)
# 5 GB

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

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache.example.gateway_arn,
    networkInterfaceId: aws_instance.example.private_ip,
    targetName: "example",
    volumeSizeInBytes: 5368709120,
});
// 5 GB

resources:
  example:
    type: aws:storagegateway:CachesIscsiVolume
    properties:
      gatewayArn: ${aws_storagegateway_cache.example.gateway_arn}
      networkInterfaceId: ${aws_instance.example.private_ip}
      targetName: example
      volumeSizeInBytes: 5.36870912e+09

Create Cached iSCSI Volume From Snapshot

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new()
    {
        GatewayArn = aws_storagegateway_cache.Example.Gateway_arn,
        NetworkInterfaceId = aws_instance.Example.Private_ip,
        SnapshotId = aws_ebs_snapshot.Example.Id,
        TargetName = "example",
        VolumeSizeInBytes = aws_ebs_snapshot.Example.Volume_size * 1024 * 1024 * 1024,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewCachesIscsiVolume(ctx, "example", &storagegateway.CachesIscsiVolumeArgs{
			GatewayArn:         pulumi.Any(aws_storagegateway_cache.Example.Gateway_arn),
			NetworkInterfaceId: pulumi.Any(aws_instance.Example.Private_ip),
			SnapshotId:         pulumi.Any(aws_ebs_snapshot.Example.Id),
			TargetName:         pulumi.String("example"),
			VolumeSizeInBytes:  aws_ebs_snapshot.Example.Volume_size * 1024 * 1024 * 1024,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.CachesIscsiVolume;
import com.pulumi.aws.storagegateway.CachesIscsiVolumeArgs;
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 CachesIscsiVolume("example", CachesIscsiVolumeArgs.builder()        
            .gatewayArn(aws_storagegateway_cache.example().gateway_arn())
            .networkInterfaceId(aws_instance.example().private_ip())
            .snapshotId(aws_ebs_snapshot.example().id())
            .targetName("example")
            .volumeSizeInBytes(aws_ebs_snapshot.example().volume_size() * 1024 * 1024 * 1024)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    snapshot_id=aws_ebs_snapshot["example"]["id"],
    target_name="example",
    volume_size_in_bytes=aws_ebs_snapshot["example"]["volume_size"] * 1024 * 1024 * 1024)

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

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache.example.gateway_arn,
    networkInterfaceId: aws_instance.example.private_ip,
    snapshotId: aws_ebs_snapshot.example.id,
    targetName: "example",
    volumeSizeInBytes: aws_ebs_snapshot.example.volume_size * 1024 * 1024 * 1024,
});

Coming soon!

Create Cached iSCSI Volume From Source Volume

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new()
    {
        GatewayArn = aws_storagegateway_cache.Example.Gateway_arn,
        NetworkInterfaceId = aws_instance.Example.Private_ip,
        SourceVolumeArn = aws_storagegateway_cached_iscsi_volume.Existing.Arn,
        TargetName = "example",
        VolumeSizeInBytes = aws_storagegateway_cached_iscsi_volume.Existing.Volume_size_in_bytes,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewCachesIscsiVolume(ctx, "example", &storagegateway.CachesIscsiVolumeArgs{
			GatewayArn:         pulumi.Any(aws_storagegateway_cache.Example.Gateway_arn),
			NetworkInterfaceId: pulumi.Any(aws_instance.Example.Private_ip),
			SourceVolumeArn:    pulumi.Any(aws_storagegateway_cached_iscsi_volume.Existing.Arn),
			TargetName:         pulumi.String("example"),
			VolumeSizeInBytes:  pulumi.Any(aws_storagegateway_cached_iscsi_volume.Existing.Volume_size_in_bytes),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.CachesIscsiVolume;
import com.pulumi.aws.storagegateway.CachesIscsiVolumeArgs;
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 CachesIscsiVolume("example", CachesIscsiVolumeArgs.builder()        
            .gatewayArn(aws_storagegateway_cache.example().gateway_arn())
            .networkInterfaceId(aws_instance.example().private_ip())
            .sourceVolumeArn(aws_storagegateway_cached_iscsi_volume.existing().arn())
            .targetName("example")
            .volumeSizeInBytes(aws_storagegateway_cached_iscsi_volume.existing().volume_size_in_bytes())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    source_volume_arn=aws_storagegateway_cached_iscsi_volume["existing"]["arn"],
    target_name="example",
    volume_size_in_bytes=aws_storagegateway_cached_iscsi_volume["existing"]["volume_size_in_bytes"])

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

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache.example.gateway_arn,
    networkInterfaceId: aws_instance.example.private_ip,
    sourceVolumeArn: aws_storagegateway_cached_iscsi_volume.existing.arn,
    targetName: "example",
    volumeSizeInBytes: aws_storagegateway_cached_iscsi_volume.existing.volume_size_in_bytes,
});

resources:
  example:
    type: aws:storagegateway:CachesIscsiVolume
    properties:
      gatewayArn: ${aws_storagegateway_cache.example.gateway_arn}
      networkInterfaceId: ${aws_instance.example.private_ip}
      sourceVolumeArn: ${aws_storagegateway_cached_iscsi_volume.existing.arn}
      targetName: example
      volumeSizeInBytes: ${aws_storagegateway_cached_iscsi_volume.existing.volume_size_in_bytes}

Create CachesIscsiVolume Resource

new CachesIscsiVolume(name: string, args: CachesIscsiVolumeArgs, opts?: CustomResourceOptions);
@overload
def CachesIscsiVolume(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      gateway_arn: Optional[str] = None,
                      kms_encrypted: Optional[bool] = None,
                      kms_key: Optional[str] = None,
                      network_interface_id: Optional[str] = None,
                      snapshot_id: Optional[str] = None,
                      source_volume_arn: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      target_name: Optional[str] = None,
                      volume_size_in_bytes: Optional[int] = None)
@overload
def CachesIscsiVolume(resource_name: str,
                      args: CachesIscsiVolumeArgs,
                      opts: Optional[ResourceOptions] = None)
func NewCachesIscsiVolume(ctx *Context, name string, args CachesIscsiVolumeArgs, opts ...ResourceOption) (*CachesIscsiVolume, error)
public CachesIscsiVolume(string name, CachesIscsiVolumeArgs args, CustomResourceOptions? opts = null)
public CachesIscsiVolume(String name, CachesIscsiVolumeArgs args)
public CachesIscsiVolume(String name, CachesIscsiVolumeArgs args, CustomResourceOptions options)

type: aws:storagegateway:CachesIscsiVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CachesIscsiVolumeArgs
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 CachesIscsiVolumeArgs
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 CachesIscsiVolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CachesIscsiVolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CachesIscsiVolumeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CachesIscsiVolume Resource Properties

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

Inputs

The CachesIscsiVolume resource accepts the following input properties:

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.

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.

VolumeSizeInBytes int

The size of the volume in bytes.

KmsEncrypted bool

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

KmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

SnapshotId string

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

SourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Tags Dictionary<string, string>

Key-value map 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.

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.

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.

VolumeSizeInBytes int

The size of the volume in bytes.

KmsEncrypted bool

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

KmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

SnapshotId string

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

SourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Tags map[string]string

Key-value map 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.

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.

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.

volumeSizeInBytes Integer

The size of the volume in bytes.

kmsEncrypted Boolean

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

kmsKey String

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

snapshotId String

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

sourceVolumeArn String

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Map<String,String>

Key-value map 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.

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.

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.

volumeSizeInBytes number

The size of the volume in bytes.

kmsEncrypted boolean

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

kmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

snapshotId string

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

sourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags {[key: string]: string}

Key-value map 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.

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.

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_size_in_bytes int

The size of the volume in bytes.

kms_encrypted bool

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

kms_key str

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

snapshot_id str

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

source_volume_arn str

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Mapping[str, str]

Key-value map 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.

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.

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.

volumeSizeInBytes Number

The size of the volume in bytes.

kmsEncrypted Boolean

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

kmsKey String

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

snapshotId String

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

sourceVolumeArn String

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Map<String>

Key-value map 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 CachesIscsiVolume 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.

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.

VolumeArn string

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

VolumeId string

Volume ID, e.g., vol-12345678.

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.

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.

VolumeArn string

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

VolumeId string

Volume ID, e.g., vol-12345678.

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.

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.

volumeArn String

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

volumeId String

Volume ID, e.g., vol-12345678.

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.

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.

volumeArn string

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

volumeId string

Volume ID, e.g., vol-12345678.

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.

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_arn str

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

volume_id str

Volume ID, e.g., vol-12345678.

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.

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.

volumeArn String

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

volumeId String

Volume ID, e.g., vol-12345678.

Look up Existing CachesIscsiVolume Resource

Get an existing CachesIscsiVolume 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?: CachesIscsiVolumeState, opts?: CustomResourceOptions): CachesIscsiVolume
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        chap_enabled: Optional[bool] = 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,
        snapshot_id: Optional[str] = None,
        source_volume_arn: 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_arn: Optional[str] = None,
        volume_id: Optional[str] = None,
        volume_size_in_bytes: Optional[int] = None) -> CachesIscsiVolume
func GetCachesIscsiVolume(ctx *Context, name string, id IDInput, state *CachesIscsiVolumeState, opts ...ResourceOption) (*CachesIscsiVolume, error)
public static CachesIscsiVolume Get(string name, Input<string> id, CachesIscsiVolumeState? state, CustomResourceOptions? opts = null)
public static CachesIscsiVolume get(String name, Output<String> id, CachesIscsiVolumeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.

GatewayArn string

The Amazon Resource Name (ARN) of the gateway.

KmsEncrypted bool

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

KmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

SnapshotId string

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

SourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Tags Dictionary<string, string>

Key-value map 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.

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.

VolumeArn string

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

VolumeId string

Volume ID, e.g., vol-12345678.

VolumeSizeInBytes int

The size of the volume in bytes.

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.

GatewayArn string

The Amazon Resource Name (ARN) of the gateway.

KmsEncrypted bool

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

KmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

SnapshotId string

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

SourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Tags map[string]string

Key-value map 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.

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.

VolumeArn string

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

VolumeId string

Volume ID, e.g., vol-12345678.

VolumeSizeInBytes int

The size of the volume in bytes.

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.

gatewayArn String

The Amazon Resource Name (ARN) of the gateway.

kmsEncrypted Boolean

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

kmsKey String

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

snapshotId String

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

sourceVolumeArn String

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Map<String,String>

Key-value map 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.

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.

volumeArn String

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

volumeId String

Volume ID, e.g., vol-12345678.

volumeSizeInBytes Integer

The size of the volume in bytes.

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.

gatewayArn string

The Amazon Resource Name (ARN) of the gateway.

kmsEncrypted boolean

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

kmsKey string

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

snapshotId string

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

sourceVolumeArn string

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags {[key: string]: string}

Key-value map 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.

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.

volumeArn string

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

volumeId string

Volume ID, e.g., vol-12345678.

volumeSizeInBytes number

The size of the volume in bytes.

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.

gateway_arn str

The Amazon Resource Name (ARN) of the gateway.

kms_encrypted bool

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

kms_key str

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

snapshot_id str

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

source_volume_arn str

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Mapping[str, str]

Key-value map 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.

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_arn str

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

volume_id str

Volume ID, e.g., vol-12345678.

volume_size_in_bytes int

The size of the volume in bytes.

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.

gatewayArn String

The Amazon Resource Name (ARN) of the gateway.

kmsEncrypted Boolean

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

kmsKey String

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. Is required when kms_encrypted is set.

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.

snapshotId String

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

sourceVolumeArn String

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The volume_size_in_bytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

tags Map<String>

Key-value map 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.

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.

volumeArn String

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

volumeId String

Volume ID, e.g., vol-12345678.

volumeSizeInBytes Number

The size of the volume in bytes.

Import

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

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.