Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. storagegateway
  6. getVolume

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.storagegateway.getVolume

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates a cached iSCSI volume on a Storage Gateway. A cached volume stores data in Amazon S3 and retains a copy of frequently accessed data subsets locally.

    Using getVolume

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOutputOptions): Output<GetVolumeResult>
    def get_volume(volume_arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(volume_arn: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetVolumeResult]
    func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

    > Note: This function is named LookupVolume in the Go SDK.

    public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:storagegateway:getVolume
  arguments:
    # arguments dictionary
    data "aws-native_storagegateway_get_volume" "name" {
    # arguments
}

    The following arguments are supported:

    VolumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    VolumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    volume_arn string
    The Amazon Resource Name (ARN) of the storage volume.
    volumeArn String
    The Amazon Resource Name (ARN) of the storage volume.
    volumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    volume_arn str
    The Amazon Resource Name (ARN) of the storage volume.
    volumeArn String
    The Amazon Resource Name (ARN) of the storage volume.

    getVolume Result

    The following output properties are available:

    CreatedDate string
    The date the volume was created.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of up to 50 tags to assign to the volume.
    TargetArn string
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    VolumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    VolumeAttachmentStatus string
    Indicates whether the storage volume is attached to or detached from the gateway.
    VolumeId string
    The unique identifier of the volume, extracted from the ARN.
    VolumeStatus string
    The status of the storage volume.
    VolumeType string
    The type of the volume (CACHED iSCSI).
    VolumeUsedInBytes double
    The size of the data stored on the volume in bytes.
    CreatedDate string
    The date the volume was created.
    Tags Tag
    A list of up to 50 tags to assign to the volume.
    TargetArn string
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    VolumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    VolumeAttachmentStatus string
    Indicates whether the storage volume is attached to or detached from the gateway.
    VolumeId string
    The unique identifier of the volume, extracted from the ARN.
    VolumeStatus string
    The status of the storage volume.
    VolumeType string
    The type of the volume (CACHED iSCSI).
    VolumeUsedInBytes float64
    The size of the data stored on the volume in bytes.
    created_date string
    The date the volume was created.
    tags list(object)
    A list of up to 50 tags to assign to the volume.
    target_arn string
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    volume_arn string
    The Amazon Resource Name (ARN) of the storage volume.
    volume_attachment_status string
    Indicates whether the storage volume is attached to or detached from the gateway.
    volume_id string
    The unique identifier of the volume, extracted from the ARN.
    volume_status string
    The status of the storage volume.
    volume_type string
    The type of the volume (CACHED iSCSI).
    volume_used_in_bytes number
    The size of the data stored on the volume in bytes.
    createdDate String
    The date the volume was created.
    tags List<Tag>
    A list of up to 50 tags to assign to the volume.
    targetArn String
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    volumeArn String
    The Amazon Resource Name (ARN) of the storage volume.
    volumeAttachmentStatus String
    Indicates whether the storage volume is attached to or detached from the gateway.
    volumeId String
    The unique identifier of the volume, extracted from the ARN.
    volumeStatus String
    The status of the storage volume.
    volumeType String
    The type of the volume (CACHED iSCSI).
    volumeUsedInBytes Double
    The size of the data stored on the volume in bytes.
    createdDate string
    The date the volume was created.
    tags Tag[]
    A list of up to 50 tags to assign to the volume.
    targetArn string
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    volumeArn string
    The Amazon Resource Name (ARN) of the storage volume.
    volumeAttachmentStatus string
    Indicates whether the storage volume is attached to or detached from the gateway.
    volumeId string
    The unique identifier of the volume, extracted from the ARN.
    volumeStatus string
    The status of the storage volume.
    volumeType string
    The type of the volume (CACHED iSCSI).
    volumeUsedInBytes number
    The size of the data stored on the volume in bytes.
    created_date str
    The date the volume was created.
    tags Sequence[root_Tag]
    A list of up to 50 tags to assign to the volume.
    target_arn str
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    volume_arn str
    The Amazon Resource Name (ARN) of the storage volume.
    volume_attachment_status str
    Indicates whether the storage volume is attached to or detached from the gateway.
    volume_id str
    The unique identifier of the volume, extracted from the ARN.
    volume_status str
    The status of the storage volume.
    volume_type str
    The type of the volume (CACHED iSCSI).
    volume_used_in_bytes float
    The size of the data stored on the volume in bytes.
    createdDate String
    The date the volume was created.
    tags List<Property Map>
    A list of up to 50 tags to assign to the volume.
    targetArn String
    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
    volumeArn String
    The Amazon Resource Name (ARN) of the storage volume.
    volumeAttachmentStatus String
    Indicates whether the storage volume is attached to or detached from the gateway.
    volumeId String
    The unique identifier of the volume, extracted from the ARN.
    volumeStatus String
    The status of the storage volume.
    volumeType String
    The type of the volume (CACHED iSCSI).
    volumeUsedInBytes Number
    The size of the data stored on the volume in bytes.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial