1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesinstances
  5. Volume

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

aws-native.workspacesinstances.Volume

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

    Resource Type definition for AWS::WorkspacesInstances::Volume - Manages WorkSpaces Volume resources

    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,
               availability_zone: Optional[str] = None,
               encrypted: Optional[bool] = None,
               iops: Optional[int] = None,
               kms_key_id: Optional[str] = None,
               size_in_gb: Optional[int] = None,
               snapshot_id: Optional[str] = None,
               tag_specifications: Optional[Sequence[VolumeTagSpecificationArgs]] = None,
               throughput: Optional[int] = None,
               volume_type: Optional[VolumeType] = 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:workspacesinstances:Volume
    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 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:

    AvailabilityZone string
    The Availability Zone in which to create the volume
    Encrypted bool
    Indicates whether the volume should be encrypted
    Iops int
    The number of I/O operations per second (IOPS)
    KmsKeyId string
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    SizeInGb int
    The size of the volume, in GiBs
    SnapshotId string
    The snapshot from which to create the volume
    TagSpecifications List<Pulumi.AwsNative.WorkspacesInstances.Inputs.VolumeTagSpecification>
    The tags passed to EBS volume
    Throughput int
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    VolumeType Pulumi.AwsNative.WorkspacesInstances.VolumeType
    The volume type
    AvailabilityZone string
    The Availability Zone in which to create the volume
    Encrypted bool
    Indicates whether the volume should be encrypted
    Iops int
    The number of I/O operations per second (IOPS)
    KmsKeyId string
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    SizeInGb int
    The size of the volume, in GiBs
    SnapshotId string
    The snapshot from which to create the volume
    TagSpecifications []VolumeTagSpecificationArgs
    The tags passed to EBS volume
    Throughput int
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    VolumeType VolumeType
    The volume type
    availabilityZone String
    The Availability Zone in which to create the volume
    encrypted Boolean
    Indicates whether the volume should be encrypted
    iops Integer
    The number of I/O operations per second (IOPS)
    kmsKeyId String
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    sizeInGb Integer
    The size of the volume, in GiBs
    snapshotId String
    The snapshot from which to create the volume
    tagSpecifications List<VolumeTagSpecification>
    The tags passed to EBS volume
    throughput Integer
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    volumeType VolumeType
    The volume type
    availabilityZone string
    The Availability Zone in which to create the volume
    encrypted boolean
    Indicates whether the volume should be encrypted
    iops number
    The number of I/O operations per second (IOPS)
    kmsKeyId string
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    sizeInGb number
    The size of the volume, in GiBs
    snapshotId string
    The snapshot from which to create the volume
    tagSpecifications VolumeTagSpecification[]
    The tags passed to EBS volume
    throughput number
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    volumeType VolumeType
    The volume type
    availability_zone str
    The Availability Zone in which to create the volume
    encrypted bool
    Indicates whether the volume should be encrypted
    iops int
    The number of I/O operations per second (IOPS)
    kms_key_id str
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    size_in_gb int
    The size of the volume, in GiBs
    snapshot_id str
    The snapshot from which to create the volume
    tag_specifications Sequence[VolumeTagSpecificationArgs]
    The tags passed to EBS volume
    throughput int
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    volume_type VolumeType
    The volume type
    availabilityZone String
    The Availability Zone in which to create the volume
    encrypted Boolean
    Indicates whether the volume should be encrypted
    iops Number
    The number of I/O operations per second (IOPS)
    kmsKeyId String
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
    sizeInGb Number
    The size of the volume, in GiBs
    snapshotId String
    The snapshot from which to create the volume
    tagSpecifications List<Property Map>
    The tags passed to EBS volume
    throughput Number
    The throughput to provision for a volume, with a maximum of 1,000 MiB/s
    volumeType "standard" | "io1" | "io2" | "gp2" | "sc1" | "st1" | "gp3"
    The volume type

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeId string
    Unique identifier for the volume
    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeId string
    Unique identifier for the volume
    id String
    The provider-assigned unique ID for this managed resource.
    volumeId String
    Unique identifier for the volume
    id string
    The provider-assigned unique ID for this managed resource.
    volumeId string
    Unique identifier for the volume
    id str
    The provider-assigned unique ID for this managed resource.
    volume_id str
    Unique identifier for the volume
    id String
    The provider-assigned unique ID for this managed resource.
    volumeId String
    Unique identifier for the volume

    Supporting Types

    VolumeTag, VolumeTagArgs

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

    VolumeTagSpecification, VolumeTagSpecificationArgs

    VolumeTagSpecificationResourceType, VolumeTagSpecificationResourceTypeArgs

    Instance
    instance
    Volume
    volume
    SpotInstancesRequest
    spot-instances-request
    NetworkInterface
    network-interface
    VolumeTagSpecificationResourceTypeInstance
    instance
    VolumeTagSpecificationResourceTypeVolume
    volume
    VolumeTagSpecificationResourceTypeSpotInstancesRequest
    spot-instances-request
    VolumeTagSpecificationResourceTypeNetworkInterface
    network-interface
    Instance
    instance
    Volume
    volume
    SpotInstancesRequest
    spot-instances-request
    NetworkInterface
    network-interface
    Instance
    instance
    Volume
    volume
    SpotInstancesRequest
    spot-instances-request
    NetworkInterface
    network-interface
    INSTANCE
    instance
    VOLUME
    volume
    SPOT_INSTANCES_REQUEST
    spot-instances-request
    NETWORK_INTERFACE
    network-interface
    "instance"
    instance
    "volume"
    volume
    "spot-instances-request"
    spot-instances-request
    "network-interface"
    network-interface

    VolumeType, VolumeTypeArgs

    Standard
    standard
    Io1
    io1
    Io2
    io2
    Gp2
    gp2
    Sc1
    sc1
    St1
    st1
    Gp3
    gp3
    VolumeTypeStandard
    standard
    VolumeTypeIo1
    io1
    VolumeTypeIo2
    io2
    VolumeTypeGp2
    gp2
    VolumeTypeSc1
    sc1
    VolumeTypeSt1
    st1
    VolumeTypeGp3
    gp3
    Standard
    standard
    Io1
    io1
    Io2
    io2
    Gp2
    gp2
    Sc1
    sc1
    St1
    st1
    Gp3
    gp3
    Standard
    standard
    Io1
    io1
    Io2
    io2
    Gp2
    gp2
    Sc1
    sc1
    St1
    st1
    Gp3
    gp3
    STANDARD
    standard
    IO1
    io1
    IO2
    io2
    GP2
    gp2
    SC1
    sc1
    ST1
    st1
    GP3
    gp3
    "standard"
    standard
    "io1"
    io1
    "io2"
    io2
    "gp2"
    gp2
    "sc1"
    sc1
    "st1"
    st1
    "gp3"
    gp3

    Package Details

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

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

    AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi