create_volume¶
Operation¶
async
¶
create_volume(input: CreateVolumeInput, plugins: list[Plugin] | None = None) -> CreateVolumeOutput
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 EBS User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateVolumeInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateVolumeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateVolumeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The ID of the Availability Zone in which to create the volume. For
example, us-east-1a.
Either AvailabilityZone or AvailabilityZoneId must be specified, but
not both.
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The ID of the Availability Zone in which to create the volume. For
example, use1-az1.
Either AvailabilityZone or AvailabilityZoneId must be specified, but
not both.
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
class-attribute
instance-attribute
¶
encrypted: bool | None = ...
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 EBS User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
class-attribute
instance-attribute
¶
iops: int | None = ...
The number of I/O operations per second (IOPS) to provision for the
volume. Required for io1 and io2 volumes. Optional for gp3
volumes. Omit for all other volume types.
Valid ranges:
-
gp3:
3,000(default)- 80,000IOPS -
io1:
100 - 64,000IOPS -
io2:
100 - 256,000IOPS
Note
Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The identifier of the 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.
class-attribute
instance-attribute
¶
multi_attach_enabled: bool | None = ...
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 EBS User Guide.
class-attribute
instance-attribute
¶
Reserved for internal use.
class-attribute
instance-attribute
¶
outpost_arn: str | None = ...
The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.
class-attribute
instance-attribute
¶
size: int | None = ...
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, and you can specify a volume size that is equal to or larger than the snapshot size.
Valid sizes:
-
gp2:
1 - 16,384GiB -
gp3:
1 - 65,536GiB -
io1:
4 - 16,384GiB -
io2:
4 - 65,536GiB -
st1 and sc1:
125 - 16,384GiB -
standard:
1 - 1024GiB
class-attribute
instance-attribute
¶
snapshot_id: str | None = ...
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the volume during creation.
class-attribute
instance-attribute
¶
throughput: int | None = ...
The throughput to provision for the volume, in MiB/s. Supported for
gp3 volumes only. Omit for all other volume types.
Valid Range: 125 - 2000 MiB/s
class-attribute
instance-attribute
¶
volume_initialization_rate: int | None = ...
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
- You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
- You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
class-attribute
instance-attribute
¶
volume_type: str | None = ...
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
Warning
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be
used as boot volumes.
For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: gp2
Output¶
dataclass
¶
Bases: _SerdeShape
Describes a volume.
Attributes¶
class-attribute
instance-attribute
¶
attachments: list[VolumeAttachment] | None = ...
Note
This parameter is not returned by CreateVolume.
Information about the volume attachments.
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The Availability Zone for the volume.
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The ID of the Availability Zone for the volume.
class-attribute
instance-attribute
¶
create_time: datetime | None = ...
The time stamp when volume creation was initiated.
class-attribute
instance-attribute
¶
encrypted: bool | None = ...
Indicates whether the volume is encrypted.
class-attribute
instance-attribute
¶
fast_restored: bool | None = ...
Note
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
class-attribute
instance-attribute
¶
iops: int | None = ...
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.
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
class-attribute
instance-attribute
¶
multi_attach_enabled: bool | None = ...
Indicates whether Amazon EBS Multi-Attach is enabled.
class-attribute
instance-attribute
¶
The service provider that manages the volume.
class-attribute
instance-attribute
¶
outpost_arn: str | None = ...
The Amazon Resource Name (ARN) of the Outpost.
class-attribute
instance-attribute
¶
owner_id: str | None = ...
The ID of the Amazon Web Services account that owns the volume.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
snapshot_id: str | None = ...
The snapshot from which the volume was created, if applicable.
class-attribute
instance-attribute
¶
source_volume_id: str | None = ...
The ID of the source volume from which the volume copy was created. Only for volume copies.
class-attribute
instance-attribute
¶
sse_type: str | None = ...
Note
This parameter is not returned by CreateVolume.
Reserved for future use.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
Any tags assigned to the volume.
class-attribute
instance-attribute
¶
throughput: int | None = ...
The throughput that the volume supports, in MiB/s.
class-attribute
instance-attribute
¶
volume_arn: str | None = ...
The Amazon Resource Name (ARN) of the volume.
class-attribute
instance-attribute
¶
volume_initialization_rate: int | None = ...
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.