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.

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

You can create encrypted volumes. Encrypted volumes must 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 Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Create 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.

Public Property ClientToken System.String

Gets and sets the property ClientToken.

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Public Property Iops 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.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Public Property MultiAttachEnabled System.Boolean

Gets and sets the property MultiAttachEnabled.

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Public Property OutpostArn System.String

Gets and sets the property OutpostArn.

The Amazon Resource Name (ARN) of the Outpost.

Public Property Size System.Int32

Gets and sets the property Size.

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Public Property SnapshotId System.String

Gets and sets the property SnapshotId.

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

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 Throughput System.Int32

Gets and sets the property Throughput.

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

Public Property VolumeType Amazon.EC2.VolumeType

Gets and sets the property VolumeType.

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: gp2

Examples

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

To create a new volume


var client = new AmazonEC2Client();
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;
int iops = response.Iops;
int 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 client = new AmazonEC2Client();
var response = client.CreateVolume(new CreateVolumeRequest 
{
    AvailabilityZone = "us-east-1a",
    Iops = 1000,
    SnapshotId = "snap-066877671789bd71b",
    VolumeType = "io1"
});

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

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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