Skip to content

Commit 8e9b368

Browse files
author
awstools
committed
docs(client-ec2): Doc-only updates for Amazon EC2
1 parent bee323d commit 8e9b368

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+192
-157
lines changed

clients/client-ec2/src/commands/AssociateRouteServerCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface AssociateRouteServerCommandOutput extends AssociateRouteServerR
2929

3030
/**
3131
* <p>Associates a route server with a VPC to enable dynamic route updates.</p>
32-
* <p>A route server association is the connection established between a route server and a VPC. This is a fundamental configuration step that enables the route server to work with appliances in your VPC.</p>
33-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
32+
* <p>A route server association is the connection established between a route server and a VPC.</p>
33+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export interface CreateRestoreImageTaskCommandOutput extends CreateRestoreImageT
3131
* <p>Starts a task that restores an AMI from an Amazon S3 object that was previously created by
3232
* using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
3333
* <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the
34-
* <i>Amazon EC2 User Guide</i>.</p>
34+
* <i>Amazon EC2 User Guide</i>.</p>
3535
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using
36-
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
36+
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

clients/client-ec2/src/commands/CreateRouteServerCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ export interface CreateRouteServerCommandOutput extends CreateRouteServerResult,
2929

3030
/**
3131
* <p>Creates a new route server to manage dynamic routing in a VPC.</p>
32-
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
32+
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature,
33+
* VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
3334
* <p>Route server supports the follow route table types:</p>
3435
* <ul>
3536
* <li>
36-
* <p>VPC route tables</p>
37+
* <p>VPC route tables not associated with subnets</p>
3738
* </li>
3839
* <li>
3940
* <p>Subnet route tables</p>
@@ -43,7 +44,7 @@ export interface CreateRouteServerCommandOutput extends CreateRouteServerResult,
4344
* </li>
4445
* </ul>
4546
* <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</p>
46-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
47+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
4748
* @example
4849
* Use a bare-bones client and the command you need to make an API call.
4950
* ```javascript

clients/client-ec2/src/commands/CreateRouteServerEndpointCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface CreateRouteServerEndpointCommandOutput extends CreateRouteServe
2929

3030
/**
3131
* <p>Creates a new endpoint for a route server in a specified subnet.</p>
32-
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. Create two endpoints per subnet for redundancy.</p>
32+
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates <a href="https://en.wikipedia.org/wiki/Border_Gateway_Protocol">BGP (Border Gateway Protocol)</a> connections between your route server and your BGP peers.</p>
33+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

clients/client-ec2/src/commands/CreateRouteServerPeerCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreateRouteServerPeerCommandOutput extends CreateRouteServerPee
2929

3030
/**
3131
* <p>Creates a new BGP peer for a specified route server endpoint.</p>
32-
* <p>A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:</p>
32+
* <p>A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:</p>
3333
* <ul>
3434
* <li>
3535
* <p>Have an elastic network interface in the VPC</p>
@@ -41,6 +41,7 @@ export interface CreateRouteServerPeerCommandOutput extends CreateRouteServerPee
4141
* <p>Can initiate BGP sessions</p>
4242
* </li>
4343
* </ul>
44+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
4445
* @example
4546
* Use a bare-bones client and the command you need to make an API call.
4647
* ```javascript

clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface CreateStoreImageTaskCommandOutput extends CreateStoreImageTaskR
3030
/**
3131
* <p>Stores an AMI as a single object in an Amazon S3 bucket.</p>
3232
* <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the
33-
* <i>Amazon EC2 User Guide</i>.</p>
33+
* <i>Amazon EC2 User Guide</i>.</p>
3434
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using
35-
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
35+
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-ec2/src/commands/DeleteRouteServerCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ export interface DeleteRouteServerCommandOutput extends DeleteRouteServerResult,
2929

3030
/**
3131
* <p>Deletes the specified route server.</p>
32-
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
32+
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature,
33+
* VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
3334
* <p>Route server supports the follow route table types:</p>
3435
* <ul>
3536
* <li>
36-
* <p>VPC route tables</p>
37+
* <p>VPC route tables not associated with subnets</p>
3738
* </li>
3839
* <li>
3940
* <p>Subnet route tables</p>
@@ -43,7 +44,7 @@ export interface DeleteRouteServerCommandOutput extends DeleteRouteServerResult,
4344
* </li>
4445
* </ul>
4546
* <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</p>
46-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
47+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
4748
* @example
4849
* Use a bare-bones client and the command you need to make an API call.
4950
* ```javascript

clients/client-ec2/src/commands/DeleteRouteServerEndpointCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DeleteRouteServerEndpointCommandOutput extends DeleteRouteServe
2929

3030
/**
3131
* <p>Deletes the specified route server endpoint.</p>
32-
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. Create two endpoints per subnet for redundancy.</p>
32+
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates <a href="https://en.wikipedia.org/wiki/Border_Gateway_Protocol">BGP (Border Gateway Protocol)</a> connections between your route server and your BGP peers.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-ec2/src/commands/DeleteRouteServerPeerCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DeleteRouteServerPeerCommandOutput extends DeleteRouteServerPee
2929

3030
/**
3131
* <p>Deletes the specified BGP peer from a route server.</p>
32-
* <p>A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:</p>
32+
* <p>A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:</p>
3333
* <ul>
3434
* <li>
3535
* <p>Have an elastic network interface in the VPC</p>

clients/client-ec2/src/commands/DeregisterImageCommand.ts

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,30 @@ export interface DeregisterImageCommandInput extends DeregisterImageRequest {}
2828
export interface DeregisterImageCommandOutput extends DeregisterImageResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new
31+
* <p>Deregisters the specified AMI. A deregistered AMI can't be used to launch new
3232
* instances.</p>
33-
* <p>If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in
34-
* the Recycle Bin for the specified retention period. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in
35-
* the <i>Amazon EC2 User Guide</i>.</p>
36-
* <p>When you deregister an AMI, it doesn't affect any instances that you've already launched
37-
* from the AMI. You'll continue to incur usage costs for those instances until you terminate
38-
* them.</p>
39-
* <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created
40-
* for the root volume of the instance during the AMI creation process. When you deregister an
41-
* instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you
42-
* created the AMI.</p>
33+
* <p>If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the
34+
* Recycle Bin for the specified retention period. It can be restored before its retention period
35+
* expires, after which it is permanently deleted. If the deregistered AMI doesn't match a
36+
* retention rule, it is permanently deleted immediately. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in
37+
* the <i>Amazon EBS User Guide</i>.</p>
38+
* <p>Deregistering an AMI does not delete the following:</p>
39+
* <ul>
40+
* <li>
41+
* <p>Instances already launched from the AMI. You'll continue to incur usage costs for the
42+
* instances until you terminate them.</p>
43+
* </li>
44+
* <li>
45+
* <p>For EBS-backed AMIs: The snapshots that were created of the root and data volumes of
46+
* the instance during AMI creation. You'll continue to incur snapshot storage costs.</p>
47+
* </li>
48+
* <li>
49+
* <p>For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll
50+
* continue to incur S3 storage costs.</p>
51+
* </li>
52+
* </ul>
53+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html">Deregister an Amazon EC2 AMI</a> in the
54+
* <i>Amazon EC2 User Guide</i>.</p>
4355
* @example
4456
* Use a bare-bones client and the command you need to make an API call.
4557
* ```javascript

clients/client-ec2/src/commands/DescribeRouteServerEndpointsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface DescribeRouteServerEndpointsCommandOutput
3131

3232
/**
3333
* <p>Describes one or more route server endpoints.</p>
34-
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. Create two endpoints per subnet for redundancy.</p>
35-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
34+
* <p>A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates <a href="https://en.wikipedia.org/wiki/Border_Gateway_Protocol">BGP (Border Gateway Protocol)</a> connections between your route server and your BGP peers.</p>
35+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-ec2/src/commands/DescribeRouteServerPeersCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DescribeRouteServerPeersCommandOutput extends DescribeRouteServ
2929

3030
/**
3131
* <p>Describes one or more route server peers.</p>
32-
* <p>A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:</p>
32+
* <p>A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:</p>
3333
* <ul>
3434
* <li>
3535
* <p>Have an elastic network interface in the VPC</p>
@@ -41,7 +41,7 @@ export interface DescribeRouteServerPeersCommandOutput extends DescribeRouteServ
4141
* <p>Can initiate BGP sessions</p>
4242
* </li>
4343
* </ul>
44-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
44+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

clients/client-ec2/src/commands/DescribeRouteServersCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ export interface DescribeRouteServersCommandOutput extends DescribeRouteServersR
2929

3030
/**
3131
* <p>Describes one or more route servers.</p>
32-
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
32+
* <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature,
33+
* VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
3334
* <p>Route server supports the follow route table types:</p>
3435
* <ul>
3536
* <li>
36-
* <p>VPC route tables</p>
37+
* <p>VPC route tables not associated with subnets</p>
3738
* </li>
3839
* <li>
3940
* <p>Subnet route tables</p>
@@ -43,7 +44,7 @@ export interface DescribeRouteServersCommandOutput extends DescribeRouteServersR
4344
* </li>
4445
* </ul>
4546
* <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</p>
46-
* <p>For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
47+
* <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
4748
* @example
4849
* Use a bare-bones client and the command you need to make an API call.
4950
* ```javascript

0 commit comments

Comments
 (0)