Skip to content

Commit f963bdd

Browse files
author
awstools
committed
docs(client-ec2): Documentation updates for Amazon EC2.
1 parent fc1c8ac commit f963bdd

19 files changed

+317
-200
lines changed

‎clients/client-ec2/src/EC2.ts

Lines changed: 49 additions & 80 deletions
Large diffs are not rendered by default.

‎clients/client-ec2/src/commands/AcceptVpcEndpointConnectionsCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ export interface AcceptVpcEndpointConnectionsCommandOutput
2424
__MetadataBearer {}
2525

2626
/**
27-
* <p>Accepts one or more interface VPC endpoint connection requests to your VPC endpoint
28-
* service.</p>
27+
* <p>Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.</p>
2928
* @example
3029
* Use a bare-bones client and the command you need to make an API call.
3130
* ```javascript

‎clients/client-ec2/src/commands/CreateCustomerGatewayCommand.ts

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,35 +29,14 @@ export interface CreateCustomerGatewayCommandOutput extends CreateCustomerGatewa
2929
* interface. The IP address must be static and can be behind a device performing network
3030
* address translation (NAT).</p>
3131
* <p>For devices that use Border Gateway Protocol (BGP), you can also provide the device's
32-
* BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your
33-
* network. If you don't have an ASN already, you can use a private ASN (in the 64512 -
34-
* 65534 range).</p>
35-
* <note>
36-
* <p>Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with
37-
* the exception of the following:</p>
38-
* <ul>
39-
* <li>
40-
* <p>7224 - reserved in the <code>us-east-1</code> Region</p>
41-
* </li>
42-
* <li>
43-
* <p>9059 - reserved in the <code>eu-west-1</code> Region</p>
44-
* </li>
45-
* <li>
46-
* <p>17943 - reserved in the <code>ap-southeast-1</code> Region</p>
47-
* </li>
48-
* <li>
49-
* <p>10124 - reserved in the <code>ap-northeast-1</code> Region</p>
50-
* </li>
51-
* </ul>
52-
* </note>
53-
* <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN
54-
* User Guide</i>.</p>
55-
* <important>
56-
* <p>To create more than one customer gateway with the same VPN type, IP address, and
57-
* BGP ASN, specify a unique device name for each customer gateway. Identical requests
58-
* return information about the existing customer gateway and do not create new
59-
* customer gateways.</p>
60-
* </important>
32+
* BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.
33+
* If you don't have an ASN already, you can use a private ASN. For more information, see
34+
* <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html">Customer gateway
35+
* options for your Site-to-Site VPN connection</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p>
36+
* <p>To create more than one customer gateway with the same VPN type, IP address, and
37+
* BGP ASN, specify a unique device name for each customer gateway. An identical request
38+
* returns information about the existing customer gateway; it doesn't create a new customer
39+
* gateway.</p>
6140
* @example
6241
* Use a bare-bones client and the command you need to make an API call.
6342
* ```javascript

‎clients/client-ec2/src/commands/CreateImageCommand.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB
2121
/**
2222
* <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance
2323
* that is either running or stopped.</p>
24-
* <important>
25-
* <p>By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on
26-
* the instance is stopped and in a consistent state during the creation process. If you're confident that your
27-
* instance is in a consistent state appropriate for AMI creation, use the <b>NoReboot</b>
28-
* parameter to prevent Amazon EC2 from shutting down and rebooting the instance. </p>
29-
* </important>
24+
* <p>By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can
25+
* take snapshots of the attached volumes while data is at rest, in order to ensure a consistent
26+
* state. You can set the <code>NoReboot</code> parameter to <code>true</code> in the API request,
27+
* or use the <code>--no-reboot</code> option in the CLI to prevent Amazon EC2 from shutting down and
28+
* rebooting the instance.</p>
29+
* <important>
30+
* <p>If you choose to bypass the shutdown and reboot process by setting the <code>NoReboot</code>
31+
* parameter to <code>true</code> in the API request, or by using the <code>--no-reboot</code> option
32+
* in the CLI, we can't guarantee the file system integrity of the created image.</p>
33+
* </important>
3034
*
3135
*
3236
*

‎clients/client-ec2/src/commands/CreateIpamCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ export interface CreateIpamCommandInput extends CreateIpamRequest {}
1919
export interface CreateIpamCommandOutput extends CreateIpamResult, __MetadataBearer {}
2020

2121
/**
22-
* <p>Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.</p>
22+
* <p>Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use
23+
* to automate your IP address management workflows including assigning, tracking,
24+
* troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts
25+
* throughout your Amazon Web Services Organization.</p>
2326
* <p>For more information, see <a href="/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.
2427
* </p>
2528
* @example

‎clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,16 @@ export interface CreateLaunchTemplateCommandInput extends CreateLaunchTemplateRe
2222
export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateResult, __MetadataBearer {}
2323

2424
/**
25-
* <p>Creates a launch template. A launch template contains the parameters to launch an
25+
* <p>Creates a launch template.</p>
26+
* <p>A launch template contains the parameters to launch an
2627
* instance. When you launch an instance using <a>RunInstances</a>, you can
2728
* specify a launch template instead of providing the launch parameters in the request. For
2829
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launching an instance from a
2930
* launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
31+
* <p>If you want to clone an existing launch template as the basis for creating a new
32+
* launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support
33+
* cloning a template. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template">Create a launch template from an existing launch template</a> in the
34+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
3035
* @example
3136
* Use a bare-bones client and the command you need to make an API call.
3237
* ```javascript

‎clients/client-ec2/src/commands/CreateVpcEndpointCommand.ts

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,7 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointResult,
2525
* <p>Creates a VPC endpoint for a specified service. An endpoint enables you to create a
2626
* private connection between your VPC and the service. The service may be provided by Amazon Web Services,
2727
* an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information,
28-
* see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html">VPC Endpoints</a> in the
29-
* <i>Amazon Virtual Private Cloud User Guide</i>.</p>
30-
* <p>A <code>gateway</code> endpoint serves as a target for a route in your route table for
31-
* traffic destined for the Amazon Web Service. You can specify an endpoint policy to attach
32-
* to the endpoint, which will control access to the service from your VPC. You can also
33-
* specify the VPC route tables that use the endpoint.</p>
34-
* <p>An <code>interface</code> endpoint is a network interface in your subnet that
35-
* serves as an endpoint for communicating with the specified service. You can specify the
36-
* subnets in which to create an endpoint, and the security groups to associate with the
37-
* endpoint network interface.</p>
38-
* <p>A <code>GatewayLoadBalancer</code> endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.</p>
39-
* <p>Use <a>DescribeVpcEndpointServices</a> to get a list of supported
40-
* services.</p>
28+
* see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>.</p>
4129
* @example
4230
* Use a bare-bones client and the command you need to make an API call.
4331
* ```javascript

‎clients/client-ec2/src/commands/CreateVpcEndpointServiceConfigurationCommand.ts

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,23 @@ export interface CreateVpcEndpointServiceConfigurationCommandOutput
2828
__MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a VPC endpoint service configuration to which service consumers (Amazon Web Services accounts,
31+
* <p>Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,
3232
* IAM users, and IAM roles) can connect.</p>
33-
* <p>To create an endpoint service configuration, you must first create one of the
34-
* following for your service:</p>
33+
* <p>Before you create an endpoint service, you must create one of the following for your service:</p>
3534
* <ul>
3635
* <li>
37-
* <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html">Network Load Balancer</a>. Service consumers connect to your service using an
38-
* interface endpoint.</p>
36+
* <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/">Network Load Balancer</a>.
37+
* Service consumers connect to your service using an interface endpoint.</p>
3938
* </li>
4039
* <li>
41-
* <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/introduction.html">Gateway Load Balancer</a>. Service consumers connect to your service using a
42-
* Gateway Load Balancer endpoint.</p>
40+
* <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/">Gateway Load Balancer</a>.
41+
* Service consumers connect to your service using a Gateway Load Balancer endpoint.</p>
4342
* </li>
4443
* </ul>
45-
* <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html">VPC Endpoint Services</a> in the
46-
* <i>Amazon Virtual Private Cloud User Guide</i>. </p>
4744
* <p>If you set the private DNS name, you must prove that you own the private DNS domain
48-
* name. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-services-dns-validation.html">VPC Endpoint Service
49-
* Private DNS Name Verification</a> in the
50-
* <i>Amazon Virtual Private Cloud User Guide</i>.</p>
45+
* name.</p>
46+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink
47+
* Guide</a>.</p>
5148
* @example
5249
* Use a bare-bones client and the command you need to make an API call.
5350
* ```javascript

‎clients/client-ec2/src/commands/DeleteIpamCommand.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ export interface DeleteIpamCommandOutput extends DeleteIpamResult, __MetadataBea
2020

2121
/**
2222
* <p>Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.</p>
23-
* <note>
24-
* <p>You cannot delete an IPAM if there are CIDRs provisioned to pools or if there are allocations in the pools within the IPAM. To deprovision pool
25-
* CIDRs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html">DeprovisionIpamPoolCidr</a>. To release allocations, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html">ReleaseIpamPoolAllocation</a>.
26-
* </p>
27-
* </note>
2823
* <p>For more information, see <a href="/vpc/latest/ipam/delete-ipam.html">Delete an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.
2924
* </p>
3025
* @example

‎clients/client-ec2/src/commands/ModifyVolumeCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ export interface ModifyVolumeCommandOutput extends ModifyVolumeResult, __Metadat
3333
* about tracking status changes using either method, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html">Monitor the progress of volume modifications</a>.</p>
3434
* <p>With previous-generation instance types, resizing an EBS volume might require detaching and
3535
* reattaching the volume or stopping and restarting the instance.</p>
36-
* <p>If you reach the maximum volume modification rate per volume limit, you must wait
37-
* at least six hours before applying further modifications to the affected EBS volume.</p>
36+
* <p>After modifying a volume, you must wait at least six hours and ensure that the volume
37+
* is in the <code>in-use</code> or <code>available</code> state before you can modify the same
38+
* volume. This is sometimes referred to as a cooldown period.</p>
3839
* @example
3940
* Use a bare-bones client and the command you need to make an API call.
4041
* ```javascript

‎clients/client-ec2/src/commands/ModifyVpcEndpointCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ export interface ModifyVpcEndpointCommandOutput extends ModifyVpcEndpointResult,
2323

2424
/**
2525
* <p>Modifies attributes of a specified VPC endpoint. The attributes that you can modify
26-
* depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see
27-
* <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html">VPC
28-
* Endpoints</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
26+
* depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information,
27+
* see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink
28+
* Guide</a>.</p>
2929
* @example
3030
* Use a bare-bones client and the command you need to make an API call.
3131
* ```javascript

‎clients/client-ec2/src/commands/ModifyVpcEndpointServiceConfigurationCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ export interface ModifyVpcEndpointServiceConfigurationCommandOutput
3333
* required for requests to connect to your endpoint service through an interface VPC
3434
* endpoint.</p>
3535
* <p>If you set or modify the private DNS name, you must prove that you own the private DNS
36-
* domain name. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-services-dns-validation.html">VPC Endpoint Service
37-
* Private DNS Name Verification</a> in the
38-
* <i>Amazon Virtual Private Cloud User Guide</i>.</p>
36+
* domain name.</p>
3937
* @example
4038
* Use a bare-bones client and the command you need to make an API call.
4139
* ```javascript

‎clients/client-ec2/src/commands/ModifyVpcEndpointServicePermissionsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ export interface ModifyVpcEndpointServicePermissionsCommandOutput
2727
__MetadataBearer {}
2828

2929
/**
30-
* <p>Modifies the permissions for your <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html">VPC endpoint service</a>. You can add or remove permissions for service consumers (IAM users,
31-
* IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.</p>
30+
* <p>Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers
31+
* (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.</p>
3232
* <p>If you grant permissions to all principals, the service is public. Any users who know the name of a
3333
* public service can send a request to attach an endpoint. If the service does not require manual approval,
3434
* attachments are automatically approved.</p>

‎clients/client-ec2/src/commands/StartVpcEndpointServicePrivateDnsVerificationCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface StartVpcEndpointServicePrivateDnsVerificationCommandOutput
3131
* <p>Initiates the verification process to prove that the service provider owns the private
3232
* DNS name domain for the endpoint service.</p>
3333
* <p>The service provider must successfully perform the verification before the consumer can use the name to access the service.</p>
34-
* <p>Before the service provider runs this command, they must add a record to the DNS server. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-services-dns-validation.html#add-dns-txt-record">Adding a TXT Record to Your Domain's DNS Server </a> in the <i>Amazon VPC User Guide</i>.</p>
34+
* <p>Before the service provider runs this command, they must add a record to the DNS server.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2252,6 +2252,9 @@ export interface EbsBlockDevice {
22522252

22532253
/**
22542254
* <p>The ARN of the Outpost on which the snapshot is stored.</p>
2255+
* <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called
2256+
* by <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html">
2257+
* CreateImage</a>.</p>
22552258
*/
22562259
OutpostArn?: string;
22572260

@@ -2355,11 +2358,17 @@ export interface CreateImageRequest {
23552358
Name: string | undefined;
23562359

23572360
/**
2358-
* <p>By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
2359-
* If the <code>No Reboot</code> option is set, Amazon EC2 doesn't shut down the instance before creating
2360-
* the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted
2361-
* at the same time), but not application consistent (all the operating system buffers are not flushed
2362-
* to disk before the snapshots are created).</p>
2361+
* <p>By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can
2362+
* take snapshots of the attached volumes while data is at rest, in order to ensure a consistent
2363+
* state. You can set the <code>NoReboot</code> parameter to <code>true</code> in the API request,
2364+
* or use the <code>--no-reboot</code> option in the CLI to prevent Amazon EC2 from shutting down and
2365+
* rebooting the instance.</p>
2366+
* <important>
2367+
* <p>If you choose to bypass the shutdown and reboot process by setting the <code>NoReboot</code>
2368+
* parameter to <code>true</code> in the API request, or by using the <code>--no-reboot</code> option
2369+
* in the CLI, we can't guarantee the file system integrity of the created image.</p>
2370+
* </important>
2371+
* <p>Default: <code>false</code> (follow standard reboot process)</p>
23632372
*/
23642373
NoReboot?: boolean;
23652374

@@ -3448,7 +3457,7 @@ export interface CreateKeyPairRequest {
34483457
DryRun?: boolean;
34493458

34503459
/**
3451-
* <p>The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.</p>
3460+
* <p>The type of key pair. Note that ED25519 keys are not supported for Windows instances.</p>
34523461
* <p>Default: <code>rsa</code>
34533462
* </p>
34543463
*/
@@ -4440,6 +4449,9 @@ export namespace LaunchTemplateTagSpecificationRequest {
44404449

44414450
/**
44424451
* <p>The information to include in the launch template.</p>
4452+
* <note>
4453+
* <p>You must specify at least one parameter for the launch template data.</p>
4454+
* </note>
44434455
*/
44444456
export interface RequestLaunchTemplateData {
44454457
/**

0 commit comments

Comments
 (0)