Skip to content

Commit c155b9e

Browse files
author
awstools
committed
feat(client-ec2): Documentation updates for Elastic Compute Cloud (EC2).
1 parent b5ca023 commit c155b9e

File tree

8 files changed

+70
-26
lines changed

8 files changed

+70
-26
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface ModifyInstancePlacementCommandOutput extends ModifyInstancePlac
6565
* GroupName: "STRING_VALUE",
6666
* HostId: "STRING_VALUE",
6767
* InstanceId: "STRING_VALUE", // required
68-
* Tenancy: "dedicated" || "host",
68+
* Tenancy: "default" || "dedicated" || "host",
6969
* PartitionNumber: Number("int"),
7070
* HostResourceGroupArn: "STRING_VALUE",
7171
* GroupId: "STRING_VALUE",

clients/client-ec2/src/models/models_0.ts

+35-1
Original file line numberDiff line numberDiff line change
@@ -3101,7 +3101,41 @@ export interface ByoipCidr {
31013101
StatusMessage?: string;
31023102

31033103
/**
3104-
* <p>The state of the address pool.</p>
3104+
* <p>The state of the address range.</p>
3105+
* <ul>
3106+
* <li>
3107+
* <p>
3108+
* <code>advertised</code>: The address range is being advertised to the internet by Amazon Web Services.</p>
3109+
* </li>
3110+
* <li>
3111+
* <p>
3112+
* <code>deprovisioned</code>: The address range is deprovisioned.</p>
3113+
* </li>
3114+
* <li>
3115+
* <p>
3116+
* <code>failed-deprovision</code>: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.</p>
3117+
* </li>
3118+
* <li>
3119+
* <p>
3120+
* <code>failed-provision</code>: The request to provision the address range was unsuccessful.</p>
3121+
* </li>
3122+
* <li>
3123+
* <p>
3124+
* <code>pending-deprovision</code>: You’ve submitted a request to deprovision an address range and it's pending.</p>
3125+
* </li>
3126+
* <li>
3127+
* <p>
3128+
* <code>pending-provision</code>: You’ve submitted a request to provision an address range and it's pending.</p>
3129+
* </li>
3130+
* <li>
3131+
* <p>
3132+
* <code>provisioned</code>: The address range is provisioned and can be advertised. The range is not currently advertised.</p>
3133+
* </li>
3134+
* <li>
3135+
* <p>
3136+
* <code>provisioned-not-publicly-advertisable</code>: The address range is provisioned and cannot be advertised.</p>
3137+
* </li>
3138+
* </ul>
31053139
* @public
31063140
*/
31073141
State?: ByoipCidrState;

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

+8-6
Original file line numberDiff line numberDiff line change
@@ -2224,7 +2224,7 @@ export interface InstanceRequirementsRequest {
22242224
* selects instance types with your attributes, it will exclude instance types whose price
22252225
* exceeds your specified threshold.</p>
22262226
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
2227-
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
2227+
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
22282228
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
22292229
* memory price instead of the per instance price.</p>
22302230
* <note>
@@ -3615,7 +3615,7 @@ export interface InstanceRequirements {
36153615
* selects instance types with your attributes, it will exclude instance types whose price
36163616
* exceeds your specified threshold.</p>
36173617
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
3618-
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
3618+
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
36193619
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
36203620
* memory price instead of the per instance price.</p>
36213621
* <note>
@@ -4566,16 +4566,18 @@ export interface CreateInstanceConnectEndpointRequest {
45664566
SecurityGroupIds?: string[];
45674567

45684568
/**
4569-
* <p>Indicates whether your client's IP address is preserved as the source. The value is <code>true</code> or <code>false</code>.</p>
4569+
* <p>Indicates whether the client IP address is preserved as the source. The following are the possible values.</p>
45704570
* <ul>
45714571
* <li>
4572-
* <p>If <code>true</code>, your client's IP address is used when you connect to a resource.</p>
4572+
* <p>
4573+
* <code>true</code> - Use the client IP address as the source.</p>
45734574
* </li>
45744575
* <li>
4575-
* <p>If <code>false</code>, the elastic network interface IP address is used when you connect to a resource.</p>
4576+
* <p>
4577+
* <code>false</code> - Use the network interface IP address as the source.</p>
45764578
* </li>
45774579
* </ul>
4578-
* <p>Default: <code>true</code>
4580+
* <p>Default: <code>false</code>
45794581
* </p>
45804582
* @public
45814583
*/

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -5495,7 +5495,10 @@ export interface CreateVolumeRequest {
54955495
KmsKeyId?: string;
54965496

54975497
/**
5498-
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
5498+
* <p>The Amazon Resource Name (ARN) of the Outpost on which to create the volume.</p>
5499+
* <p>If you intend to use a volume with an instance running on an outpost, then you must
5500+
* create the volume on the same outpost as the instance. You can't use a volume created
5501+
* in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.</p>
54995502
* @public
55005503
*/
55015504
OutpostArn?: string;

clients/client-ec2/src/models/models_5.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2703,7 +2703,7 @@ export interface DescribeVolumesRequest {
27032703
Filters?: Filter[];
27042704

27052705
/**
2706-
* <p>The volume IDs.</p>
2706+
* <p>The volume IDs. If not specified, then all volumes are included in the response.</p>
27072707
* @public
27082708
*/
27092709
VolumeIds?: string[];

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -5385,8 +5385,9 @@ export interface ModifyInstanceAttributeRequest {
53855385
SriovNetSupport?: AttributeValue;
53865386

53875387
/**
5388-
* <p>Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you
5389-
* can load the text from a file. Otherwise, you must provide base64-encoded text.</p>
5388+
* <p>Changes the instance's user data to the specified value. User data must be base64-encoded.
5389+
* Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.
5390+
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html">Work with instance user data</a>.</p>
53905391
* @public
53915392
*/
53925393
UserData?: BlobAttributeValue;
@@ -6012,6 +6013,7 @@ export interface ModifyInstanceMetadataOptionsResult {
60126013
*/
60136014
export const HostTenancy = {
60146015
dedicated: "dedicated",
6016+
default: "default",
60156017
host: "host",
60166018
} as const;
60176019

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

+3-6
Original file line numberDiff line numberDiff line change
@@ -3188,12 +3188,9 @@ export interface RunInstancesRequest {
31883188
SubnetId?: string;
31893189

31903190
/**
3191-
* <p>The user data script to make available to the instance. For more information, see
3192-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html">Run
3193-
* commands on your Amazon EC2 instance at launch</a> in the <i>Amazon EC2 User
3194-
* Guide</i>. If you are using a command line tool, base64-encoding is performed
3195-
* for you, and you can load the text from a file. Otherwise, you must provide
3196-
* base64-encoded text. User data is limited to 16 KB.</p>
3191+
* <p>The user data to make available to the instance. User data must be base64-encoded.
3192+
* Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.
3193+
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html">Work with instance user data</a>.</p>
31973194
* @public
31983195
*/
31993196
UserData?: string;

0 commit comments

Comments
 (0)