We recommend new projects start with resources from the AWS provider.
aws-native.workspacesinstances.Volume
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Availability
Zone 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)
- Kms
Key stringId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- Size
In intGb - The size of the volume, in GiBs
- Snapshot
Id string - The snapshot from which to create the volume
- List<Pulumi.
Aws Native. Workspaces Instances. Inputs. Volume Tag Specification> - 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 Pulumi.Aws Native. Workspaces Instances. Volume Type - The volume type
- Availability
Zone 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)
- Kms
Key stringId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- Size
In intGb - The size of the volume, in GiBs
- Snapshot
Id string - The snapshot from which to create the volume
- []Volume
Tag Specification Args - 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
- availability
Zone 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)
- kms
Key StringId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- size
In IntegerGb - The size of the volume, in GiBs
- snapshot
Id String - The snapshot from which to create the volume
- List<Volume
Tag Specification> - The tags passed to EBS volume
- throughput Integer
- The throughput to provision for a volume, with a maximum of 1,000 MiB/s
- volume
Type VolumeType - The volume type
- availability
Zone 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)
- kms
Key stringId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- size
In numberGb - The size of the volume, in GiBs
- snapshot
Id string - The snapshot from which to create the volume
- Volume
Tag Specification[] - The tags passed to EBS volume
- throughput number
- The throughput to provision for a volume, with a maximum of 1,000 MiB/s
- volume
Type 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_ strid - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- size_
in_ intgb - The size of the volume, in GiBs
- snapshot_
id str - The snapshot from which to create the volume
- tag_
specifications Sequence[VolumeTag Specification Args] - 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
- availability
Zone 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)
- kms
Key StringId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption
- size
In NumberGb - The size of the volume, in GiBs
- snapshot
Id String - The snapshot from which to create the volume
- 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
- volume
Type "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:
Supporting Types
VolumeTag, VolumeTagArgs
VolumeTagSpecification, VolumeTagSpecificationArgs
- Resource
Type VolumeTag Specification Resource Type - []Volume
Tag - The tags to apply to the resource
- resource
Type VolumeTag Specification Resource Type - List<Volume
Tag> - The tags to apply to the resource
- resource
Type VolumeTag Specification Resource Type - Volume
Tag[] - The tags to apply to the resource
- resource_
type VolumeTag Specification Resource Type - Sequence[Volume
Tag] - The tags to apply to the resource
- resource
Type "instance" | "volume" | "spot-instances-request" | "network-interface" - List<Property Map>
- The tags to apply to the resource
VolumeTagSpecificationResourceType, VolumeTagSpecificationResourceTypeArgs
- Instance
- instance
- Volume
- volume
- Spot
Instances Request - spot-instances-request
- Network
Interface - network-interface
- Volume
Tag Specification Resource Type Instance - instance
- Volume
Tag Specification Resource Type Volume - volume
- Volume
Tag Specification Resource Type Spot Instances Request - spot-instances-request
- Volume
Tag Specification Resource Type Network Interface - 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
- 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
- Volume
Type Standard - standard
- Volume
Type Io1 - io1
- Volume
Type Io2 - io2
- Volume
Type Gp2 - gp2
- Volume
Type Sc1 - sc1
- Volume
Type St1 - st1
- Volume
Type 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
- "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
We recommend new projects start with resources from the AWS provider.