AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a volume.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.Volume

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class Volume

The Volume type exposes the following members

Constructors

NameDescription
Public Method Volume()

Properties

NameTypeDescription
Public Property Attachments System.Collections.Generic.List<Amazon.EC2.Model.VolumeAttachment>

Gets and sets the property Attachments.

This parameter is not returned by CreateVolume.

Information about the volume attachments.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The Availability Zone for the volume.

Public Property CreateTime System.Nullable<System.DateTime>

Gets and sets the property CreateTime.

The time stamp when volume creation was initiated.

Public Property Encrypted System.Nullable<System.Boolean>

Gets and sets the property Encrypted.

Indicates whether the volume is encrypted.

Public Property FastRestored System.Nullable<System.Boolean>

Gets and sets the property FastRestored.

This parameter is not returned by CreateVolume.

Indicates whether the volume was created using fast snapshot restore.

Public Property Iops System.Nullable<System.Int32>

Gets and sets the property Iops.

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.

Public Property MultiAttachEnabled System.Nullable<System.Boolean>

Gets and sets the property MultiAttachEnabled.

Indicates whether Amazon EBS Multi-Attach is enabled.

Public Property Operator Amazon.EC2.Model.OperatorResponse

Gets and sets the property Operator.

The service provider that manages the volume.

Public Property OutpostArn System.String

Gets and sets the property OutpostArn.

The Amazon Resource Name (ARN) of the Outpost.

Public Property Size System.Nullable<System.Int32>

Gets and sets the property Size.

The size of the volume, in GiBs.

Public Property SnapshotId System.String

Gets and sets the property SnapshotId.

The snapshot from which the volume was created, if applicable.

Public Property SseType Amazon.EC2.SSEType

Gets and sets the property SseType.

This parameter is not returned by CreateVolume.

Reserved for future use.

Public Property State Amazon.EC2.VolumeState

Gets and sets the property State.

The volume state.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

Any tags assigned to the volume.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Throughput System.Nullable<System.Int32>

Gets and sets the property Throughput.

The throughput that the volume supports, in MiB/s.

Public Property VolumeId System.String

Gets and sets the property VolumeId.

The ID of the volume.

Public Property VolumeInitializationRate System.Nullable<System.Int32>

Gets and sets the property VolumeInitializationRate.

The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.

Public Property VolumeType Amazon.EC2.VolumeType

Gets and sets the property VolumeType.

The volume type.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer