AWS SDK Version 3 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.

Container for the parameters to the CreateVolume operation. Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources.

For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateVolumeRequest

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

Syntax

C#
public class CreateVolumeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateVolumeRequest type exposes the following members

Constructors

NameDescription
Public Method CreateVolumeRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateVolumeRequest(string, int)

Instantiates CreateVolumeRequest with the parameterized properties

Public Method CreateVolumeRequest(string, string)

Instantiates CreateVolumeRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Public Property Iops System.Int32

Gets and sets the property Iops.

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

Public Property Size System.Int32

Gets and sets the property Size.

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Public Property SnapshotId System.String

Gets and sets the property SnapshotId.

The snapshot from which to create the volume.

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

The tags to apply to the volume during creation.

Public Property VolumeType Amazon.EC2.VolumeType

Gets and sets the property VolumeType.

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

Examples

This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.

To create a new volume


var response = client.CreateVolume(new CreateVolumeRequest 
{
    AvailabilityZone = "us-east-1a",
    Size = 80,
    VolumeType = "gp2"
});

string availabilityZone = response.AvailabilityZone;
DateTime createTime = response.CreateTime;
bool encrypted = response.Encrypted;
integer iops = response.Iops;
integer size = response.Size;
string snapshotId = response.SnapshotId;
string state = response.State;
string volumeId = response.VolumeId;
string volumeType = response.VolumeType;

            

This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.

To create a new Provisioned IOPS (SSD) volume from a snapshot


var response = client.CreateVolume(new CreateVolumeRequest 
{
    AvailabilityZone = "us-east-1a",
    Iops = 1000,
    SnapshotId = "snap-066877671789bd71b",
    VolumeType = "io1"
});

List attachments = response.Attachments;
string availabilityZone = response.AvailabilityZone;
DateTime createTime = response.CreateTime;
integer iops = response.Iops;
integer size = response.Size;
string snapshotId = response.SnapshotId;
string state = response.State;
List tags = response.Tags;
string volumeId = response.VolumeId;
string volumeType = response.VolumeType;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms