Skip to content

Commit 408c3ff

Browse files
author
awstools
committed
docs(client-ec2): Documentation updates for Amazon EC2.
1 parent 06ee66a commit 408c3ff

File tree

6 files changed

+85
-78
lines changed

6 files changed

+85
-78
lines changed

‎clients/client-ec2/src/models/models_1.ts

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4106,24 +4106,22 @@ export interface EbsBlockDevice {
41064106
* <ul>
41074107
* <li>
41084108
* <p>
4109-
* <code>gp3</code>: 3,000-16,000 IOPS</p>
4109+
* <code>gp3</code>: 3,000 - 16,000 IOPS</p>
41104110
* </li>
41114111
* <li>
41124112
* <p>
4113-
* <code>io1</code>: 100-64,000 IOPS</p>
4113+
* <code>io1</code>: 100 - 64,000 IOPS</p>
41144114
* </li>
41154115
* <li>
41164116
* <p>
4117-
* <code>io2</code>: 100-64,000 IOPS</p>
4117+
* <code>io2</code>: 100 - 256,000 IOPS</p>
41184118
* </li>
41194119
* </ul>
4120-
* <p>For <code>io1</code> and <code>io2</code> volumes, we guarantee 64,000 IOPS only for
4121-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Instances built on the
4122-
* Nitro System</a>. Other instance families guarantee performance up to
4123-
* 32,000 IOPS.</p>
4120+
* <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on
4121+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">instances
4122+
* built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p>
41244123
* <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes
4125-
* is 3,000 IOPS. This parameter is not supported for <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or <code>standard</code>
4126-
* volumes.</p>
4124+
* is 3,000 IOPS.</p>
41274125
*/
41284126
Iops?: number;
41294127

@@ -4138,23 +4136,27 @@ export interface EbsBlockDevice {
41384136
* <p>The size of the volume, in GiBs. You must specify either a snapshot ID or a volume
41394137
* size. If you specify a snapshot, the default is the snapshot size. You can specify a
41404138
* volume size that is equal to or larger than the snapshot size.</p>
4141-
* <p>The following are the supported volumes sizes for each volume type:</p>
4139+
* <p>The following are the supported sizes for each volume type:</p>
41424140
* <ul>
41434141
* <li>
41444142
* <p>
4145-
* <code>gp2</code> and <code>gp3</code>:1-16,384</p>
4143+
* <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p>
41464144
* </li>
41474145
* <li>
41484146
* <p>
4149-
* <code>io1</code> and <code>io2</code>: 4-16,384</p>
4147+
* <code>io1</code>: 4 - 16,384 GiB</p>
41504148
* </li>
41514149
* <li>
41524150
* <p>
4153-
* <code>st1</code> and <code>sc1</code>: 125-16,384</p>
4151+
* <code>io2</code>: 4 - 65,536 GiB</p>
41544152
* </li>
41554153
* <li>
41564154
* <p>
4157-
* <code>standard</code>: 1-1,024</p>
4155+
* <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p>
4156+
* </li>
4157+
* <li>
4158+
* <p>
4159+
* <code>standard</code>: 1 - 1024 GiB</p>
41584160
* </li>
41594161
* </ul>
41604162
*/
@@ -4163,8 +4165,7 @@ export interface EbsBlockDevice {
41634165
/**
41644166
* @public
41654167
* <p>The volume type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the
4166-
* <i>Amazon EC2 User Guide</i>. If the volume type is <code>io1</code> or
4167-
* <code>io2</code>, you must specify the IOPS that the volume supports.</p>
4168+
* <i>Amazon EC2 User Guide</i>.</p>
41684169
*/
41694170
VolumeType?: VolumeType;
41704171

@@ -6150,23 +6151,21 @@ export interface LaunchTemplateEbsBlockDeviceRequest {
61506151
* <ul>
61516152
* <li>
61526153
* <p>
6153-
* <code>gp3</code>: 3,000-16,000 IOPS</p>
6154+
* <code>gp3</code>: 3,000 - 16,000 IOPS</p>
61546155
* </li>
61556156
* <li>
61566157
* <p>
6157-
* <code>io1</code>: 100-64,000 IOPS</p>
6158+
* <code>io1</code>: 100 - 64,000 IOPS</p>
61586159
* </li>
61596160
* <li>
61606161
* <p>
6161-
* <code>io2</code>: 100-64,000 IOPS</p>
6162+
* <code>io2</code>: 100 - 256,000 IOPS</p>
61626163
* </li>
61636164
* </ul>
6164-
* <p>For <code>io1</code> and <code>io2</code> volumes, we guarantee
6165-
* 64,000 IOPS only for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Instances built on the
6166-
* Nitro System</a>. Other instance families guarantee performance up to
6167-
* 32,000 IOPS.</p>
6168-
* <p>This parameter is supported for <code>io1</code>, <code>io2</code>, and <code>gp3</code> volumes only. This parameter
6169-
* is not supported for <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or <code>standard</code> volumes.</p>
6165+
* <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on
6166+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">instances
6167+
* built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p>
6168+
* <p>This parameter is supported for <code>io1</code>, <code>io2</code>, and <code>gp3</code> volumes only.</p>
61706169
*/
61716170
Iops?: number;
61726171

@@ -6189,19 +6188,23 @@ export interface LaunchTemplateEbsBlockDeviceRequest {
61896188
* <ul>
61906189
* <li>
61916190
* <p>
6192-
* <code>gp2</code> and <code>gp3</code>: 1-16,384</p>
6191+
* <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p>
6192+
* </li>
6193+
* <li>
6194+
* <p>
6195+
* <code>io1</code>: 4 - 16,384 GiB</p>
61936196
* </li>
61946197
* <li>
61956198
* <p>
6196-
* <code>io1</code> and <code>io2</code>: 4-16,384</p>
6199+
* <code>io2</code>: 4 - 65,536 GiB</p>
61976200
* </li>
61986201
* <li>
61996202
* <p>
6200-
* <code>st1</code> and <code>sc1</code>: 125-16,384</p>
6203+
* <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p>
62016204
* </li>
62026205
* <li>
62036206
* <p>
6204-
* <code>standard</code>: 1-1,024</p>
6207+
* <code>standard</code>: 1 - 1024 GiB</p>
62056208
* </li>
62066209
* </ul>
62076210
*/

‎clients/client-ec2/src/models/models_2.ts

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5417,23 +5417,21 @@ export interface CreateVolumeRequest {
54175417
* <ul>
54185418
* <li>
54195419
* <p>
5420-
* <code>gp3</code>: 3,000-16,000 IOPS</p>
5420+
* <code>gp3</code>: 3,000 - 16,000 IOPS</p>
54215421
* </li>
54225422
* <li>
54235423
* <p>
5424-
* <code>io1</code>: 100-64,000 IOPS</p>
5424+
* <code>io1</code>: 100 - 64,000 IOPS</p>
54255425
* </li>
54265426
* <li>
54275427
* <p>
5428-
* <code>io2</code>: 100-64,000 IOPS</p>
5428+
* <code>io2</code>: 100 - 256,000 IOPS</p>
54295429
* </li>
54305430
* </ul>
5431-
* <p>
5432-
* <code>io1</code> and <code>io2</code> volumes support up to 64,000 IOPS only on
5433-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Instances built on the Nitro System</a>. Other instance families support performance
5434-
* up to 32,000 IOPS.</p>
5435-
* <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes.
5436-
* The default for <code>gp3</code> volumes is 3,000 IOPS.
5431+
* <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on
5432+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">instances
5433+
* built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p>
5434+
* <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.
54375435
* This parameter is not supported for <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or <code>standard</code> volumes.</p>
54385436
*/
54395437
Iops?: number;
@@ -5478,19 +5476,23 @@ export interface CreateVolumeRequest {
54785476
* <ul>
54795477
* <li>
54805478
* <p>
5481-
* <code>gp2</code> and <code>gp3</code>: 1-16,384</p>
5479+
* <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p>
5480+
* </li>
5481+
* <li>
5482+
* <p>
5483+
* <code>io1</code>: 4 - 16,384 GiB</p>
54825484
* </li>
54835485
* <li>
54845486
* <p>
5485-
* <code>io1</code> and <code>io2</code>: 4-16,384</p>
5487+
* <code>io2</code>: 4 - 65,536 GiB</p>
54865488
* </li>
54875489
* <li>
54885490
* <p>
5489-
* <code>st1</code> and <code>sc1</code>: 125-16,384</p>
5491+
* <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p>
54905492
* </li>
54915493
* <li>
54925494
* <p>
5493-
* <code>standard</code>: 1-1,024</p>
5495+
* <code>standard</code>: 1 - 1024 GiB</p>
54945496
* </li>
54955497
* </ul>
54965498
*/

‎clients/client-ec2/src/models/models_4.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11833,9 +11833,9 @@ export interface DescribeSpotInstanceRequestsRequest {
1183311833
* <li>
1183411834
* <p>
1183511835
* <code>launch.block-device-mapping.volume-type</code> - The type of EBS volume:
11836-
* <code>gp2</code> for General Purpose SSD, <code>io1</code> or
11837-
* <code>io2</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput
11838-
* Optimized HDD, <code>sc1</code>for Cold HDD, or <code>standard</code> for
11836+
* <code>gp2</code> or <code>gp3</code> for General Purpose SSD, <code>io1</code>
11837+
* or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput
11838+
* Optimized HDD, <code>sc1</code> for Cold HDD, or <code>standard</code> for
1183911839
* Magnetic.</p>
1184011840
* </li>
1184111841
* <li>

‎clients/client-ec2/src/models/models_6.ts

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7372,19 +7372,23 @@ export interface ModifyVolumeRequest {
73727372
* <ul>
73737373
* <li>
73747374
* <p>
7375-
* <code>gp2</code> and <code>gp3</code>: 1-16,384</p>
7375+
* <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p>
73767376
* </li>
73777377
* <li>
73787378
* <p>
7379-
* <code>io1</code> and <code>io2</code>: 4-16,384</p>
7379+
* <code>io1</code>: 4 - 16,384 GiB</p>
73807380
* </li>
73817381
* <li>
73827382
* <p>
7383-
* <code>st1</code> and <code>sc1</code>: 125-16,384</p>
7383+
* <code>io2</code>: 4 - 65,536 GiB</p>
73847384
* </li>
73857385
* <li>
73867386
* <p>
7387-
* <code>standard</code>: 1-1,024</p>
7387+
* <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p>
7388+
* </li>
7389+
* <li>
7390+
* <p>
7391+
* <code>standard</code>: 1 - 1024 GiB</p>
73887392
* </li>
73897393
* </ul>
73907394
* <p>Default: The existing size is retained.</p>
@@ -7405,17 +7409,20 @@ export interface ModifyVolumeRequest {
74057409
* <ul>
74067410
* <li>
74077411
* <p>
7408-
* <code>gp3</code>: 3,000-16,000 IOPS</p>
7412+
* <code>gp3</code>: 3,000 - 16,000 IOPS</p>
74097413
* </li>
74107414
* <li>
74117415
* <p>
7412-
* <code>io1</code>: 100-64,000 IOPS</p>
7416+
* <code>io1</code>: 100 - 64,000 IOPS</p>
74137417
* </li>
74147418
* <li>
74157419
* <p>
7416-
* <code>io2</code>: 100-64,000 IOPS</p>
7420+
* <code>io2</code>: 100 - 256,000 IOPS</p>
74177421
* </li>
74187422
* </ul>
7423+
* <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on
7424+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">instances
7425+
* built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p>
74197426
* <p>Default: The existing value is retained if you keep the same volume type. If you change
74207427
* the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
74217428
*/

‎clients/client-ec2/src/models/models_7.ts

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2655,19 +2655,15 @@ export interface ScheduledInstancesEbs {
26552655

26562656
/**
26572657
* @public
2658-
* <p>Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.</p>
2658+
* <p>Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that
2659+
* support them.</p>
26592660
*/
26602661
Encrypted?: boolean;
26612662

26622663
/**
26632664
* @public
2664-
* <p>The number of I/O operations per second (IOPS) to provision for an <code>io1</code> or <code>io2</code> volume, with a maximum
2665-
* ratio of 50 IOPS/GiB for <code>io1</code>, and 500 IOPS/GiB for <code>io2</code>. Range is 100 to 64,000 IOPS for
2666-
* volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on
2667-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">instances built on the Nitro System</a>. Other instance families guarantee performance up to
2668-
* 32,000 IOPS. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the
2669-
* <i>Amazon EC2 User Guide</i>.</p>
2670-
* <p>This parameter is valid only for Provisioned IOPS SSD (<code>io1</code> and <code>io2</code>) volumes.</p>
2665+
* <p>The number of I/O operations per second (IOPS) to provision for a <code>gp3</code>, <code>io1</code>, or <code>io2</code>
2666+
* volume.</p>
26712667
*/
26722668
Iops?: number;
26732669

@@ -2680,15 +2676,14 @@ export interface ScheduledInstancesEbs {
26802676
/**
26812677
* @public
26822678
* <p>The size of the volume, in GiB.</p>
2683-
* <p>Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.</p>
2679+
* <p>Default: If you're creating the volume from a snapshot and don't specify a volume size, the default
2680+
* is the snapshot size.</p>
26842681
*/
26852682
VolumeSize?: number;
26862683

26872684
/**
26882685
* @public
2689-
* <p>The volume type. <code>gp2</code> for General Purpose SSD, <code>io1</code> or <code> io2</code> for Provisioned IOPS SSD, Throughput Optimized HDD
2690-
* for <code>st1</code>, Cold HDD for <code>sc1</code>, or <code>standard</code> for
2691-
* Magnetic.</p>
2686+
* <p>The volume type.</p>
26922687
* <p>Default: <code>gp2</code>
26932688
* </p>
26942689
*/

0 commit comments

Comments
 (0)