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

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.Volume

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.

    Create Volume Resource

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

    Constructor syntax

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

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           gateway_arn: Optional[str] = None,
           network_interface_id: Optional[str] = None,
           target_name: Optional[str] = None,
           volume_size_in_bytes: Optional[float] = None,
           kms_encrypted: Optional[bool] = None,
           kms_key: Optional[str] = None,
           snapshot_id: Optional[str] = None,
           source_volume_arn: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

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


    resource "aws-native_storagegateway_volume" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    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 VolumeArgs
    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 VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Volume 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 Volume resource accepts the following input properties:

    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    VolumeSizeInBytes double
    The size of the volume in bytes.
    KmsEncrypted bool
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    KmsKey string
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    SourceVolumeArn string
    The ARN of an existing volume from which to create the new volume.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of up to 50 tags to assign to the volume.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    VolumeSizeInBytes float64
    The size of the volume in bytes.
    KmsEncrypted bool
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    KmsKey string
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    SnapshotId string
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    SourceVolumeArn string
    The ARN of an existing volume from which to create the new volume.
    Tags TagArgs
    A list of up to 50 tags to assign to the volume.
    gateway_arn string
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    network_interface_id string
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
    target_name string
    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
    volume_size_in_bytes number
    The size of the volume in bytes.
    kms_encrypted bool
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    kms_key string
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    snapshot_id string
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    source_volume_arn string
    The ARN of an existing volume from which to create the new volume.
    tags list(object)
    A list of up to 50 tags to assign to the volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    volumeSizeInBytes Double
    The size of the volume in bytes.
    kmsEncrypted Boolean
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    kmsKey String
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    sourceVolumeArn String
    The ARN of an existing volume from which to create the new volume.
    tags List<Tag>
    A list of up to 50 tags to assign to the volume.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    volumeSizeInBytes number
    The size of the volume in bytes.
    kmsEncrypted boolean
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    kmsKey string
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    snapshotId string
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    sourceVolumeArn string
    The ARN of an existing volume from which to create the new volume.
    tags Tag[]
    A list of up to 50 tags to assign to the volume.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    volume_size_in_bytes float
    The size of the volume in bytes.
    kms_encrypted bool
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    kms_key str
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    snapshot_id str
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    source_volume_arn str
    The ARN of an existing volume from which to create the new volume.
    tags Sequence[TagArgs]
    A list of up to 50 tags to assign to the volume.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    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 an initiator to connect to a volume and used as a suffix for the target ARN.
    volumeSizeInBytes Number
    The size of the volume in bytes.
    kmsEncrypted Boolean
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    kmsKey String
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    snapshotId String
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    sourceVolumeArn String
    The ARN of an existing volume from which to create the new volume.
    tags List<Property Map>
    A list of up to 50 tags to assign to the volume.

    Outputs

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

    CreatedDate string
    The date the volume was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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, TagArgs

    A set of tags to apply to the resource.
    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