Class 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 Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new Aws.StorageGateway.CachesIscsiVolumeArgs
    {
        GatewayArn = aws_storagegateway_cache.Example.Gateway_arn,
        NetworkInterfaceId = aws_instance.Example.Private_ip,
        TargetName = "example",
        VolumeSizeInBytes = 5368709120,
    });
    // 5 GB
}

}

Create Cached iSCSI Volume From Snapshot

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new Aws.StorageGateway.CachesIscsiVolumeArgs
    {
        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,
    });
}

}

Create Cached iSCSI Volume From Source Volume

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.CachesIscsiVolume("example", new Aws.StorageGateway.CachesIscsiVolumeArgs
    {
        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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

CachesIscsiVolume

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.StorageGateway

Assembly: Pulumi.Aws.dll

Syntax

public class CachesIscsiVolume : CustomResource

Constructors

CachesIscsiVolume(String, CachesIscsiVolumeArgs, CustomResourceOptions)

Create a CachesIscsiVolume resource with the given unique name, arguments, and options.

Declaration

public CachesIscsiVolume(string name, CachesIscsiVolumeArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
CachesIscsiVolumeArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

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

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

ChapEnabled

Whether mutual CHAP is enabled for the iSCSI target.

Declaration

public Output<bool> ChapEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

GatewayArn

The Amazon Resource Name (ARN) of the gateway.

Declaration

public Output<string> GatewayArn { get; }

Property Value

Type	Description
Output<System.String>

LunNumber

Logical disk number.

Declaration

public Output<int> LunNumber { get; }

Property Value

Type	Description
Output<System.Int32>

NetworkInterfaceId

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

Declaration

public Output<string> NetworkInterfaceId { get; }

Property Value

Type	Description
Output<System.String>

NetworkInterfacePort

The port used to communicate with iSCSI targets.

Declaration

public Output<int> NetworkInterfacePort { get; }

Property Value

Type	Description
Output<System.Int32>

SnapshotId

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

Declaration

public Output<string> SnapshotId { get; }

Property Value

Type	Description
Output<System.String>

SourceVolumeArn

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.

Declaration

public Output<string> SourceVolumeArn { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

TargetArn

Target Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.

Declaration

public Output<string> TargetArn { get; }

Property Value

Type	Description
Output<System.String>

TargetName

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.

Declaration

public Output<string> TargetName { get; }

Property Value

Type	Description
Output<System.String>

VolumeArn

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

Declaration

public Output<string> VolumeArn { get; }

Property Value

Type	Description
Output<System.String>

VolumeId

Volume ID, e.g. vol-12345678.

Declaration

public Output<string> VolumeId { get; }

Property Value

Type	Description
Output<System.String>

VolumeSizeInBytes

The size of the volume in bytes.

Declaration

public Output<int> VolumeSizeInBytes { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

Get(String, Input<String>, CachesIscsiVolumeState, CustomResourceOptions)

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

Declaration

public static CachesIscsiVolume Get(string name, Input<string> id, CachesIscsiVolumeState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
CachesIscsiVolumeState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
CachesIscsiVolume