Skip to content

Commit

Permalink
feat(client-ec2): Documentation updates for Elastic Compute Cloud (EC2).
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jul 2, 2024
1 parent b5ca023 commit c155b9e
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface ModifyInstancePlacementCommandOutput extends ModifyInstancePlac
* GroupName: "STRING_VALUE",
* HostId: "STRING_VALUE",
* InstanceId: "STRING_VALUE", // required
* Tenancy: "dedicated" || "host",
* Tenancy: "default" || "dedicated" || "host",
* PartitionNumber: Number("int"),
* HostResourceGroupArn: "STRING_VALUE",
* GroupId: "STRING_VALUE",
Expand Down
36 changes: 35 additions & 1 deletion clients/client-ec2/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3101,7 +3101,41 @@ export interface ByoipCidr {
StatusMessage?: string;

/**
* <p>The state of the address pool.</p>
* <p>The state of the address range.</p>
* <ul>
* <li>
* <p>
* <code>advertised</code>: The address range is being advertised to the internet by Amazon Web Services.</p>
* </li>
* <li>
* <p>
* <code>deprovisioned</code>: The address range is deprovisioned.</p>
* </li>
* <li>
* <p>
* <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>
* </li>
* <li>
* <p>
* <code>failed-provision</code>: The request to provision the address range was unsuccessful.</p>
* </li>
* <li>
* <p>
* <code>pending-deprovision</code>: You’ve submitted a request to deprovision an address range and it's pending.</p>
* </li>
* <li>
* <p>
* <code>pending-provision</code>: You’ve submitted a request to provision an address range and it's pending.</p>
* </li>
* <li>
* <p>
* <code>provisioned</code>: The address range is provisioned and can be advertised. The range is not currently advertised.</p>
* </li>
* <li>
* <p>
* <code>provisioned-not-publicly-advertisable</code>: The address range is provisioned and cannot be advertised.</p>
* </li>
* </ul>
* @public
*/
State?: ByoipCidrState;
Expand Down
14 changes: 8 additions & 6 deletions clients/client-ec2/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2224,7 +2224,7 @@ export interface InstanceRequirementsRequest {
* selects instance types with your attributes, it will exclude instance types whose price
* exceeds your specified threshold.</p>
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
* memory price instead of the per instance price.</p>
* <note>
Expand Down Expand Up @@ -3615,7 +3615,7 @@ export interface InstanceRequirements {
* selects instance types with your attributes, it will exclude instance types whose price
* exceeds your specified threshold.</p>
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
* memory price instead of the per instance price.</p>
* <note>
Expand Down Expand Up @@ -4566,16 +4566,18 @@ export interface CreateInstanceConnectEndpointRequest {
SecurityGroupIds?: string[];

/**
* <p>Indicates whether your client's IP address is preserved as the source. The value is <code>true</code> or <code>false</code>.</p>
* <p>Indicates whether the client IP address is preserved as the source. The following are the possible values.</p>
* <ul>
* <li>
* <p>If <code>true</code>, your client's IP address is used when you connect to a resource.</p>
* <p>
* <code>true</code> - Use the client IP address as the source.</p>
* </li>
* <li>
* <p>If <code>false</code>, the elastic network interface IP address is used when you connect to a resource.</p>
* <p>
* <code>false</code> - Use the network interface IP address as the source.</p>
* </li>
* </ul>
* <p>Default: <code>true</code>
* <p>Default: <code>false</code>
* </p>
* @public
*/
Expand Down
5 changes: 4 additions & 1 deletion clients/client-ec2/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5495,7 +5495,10 @@ export interface CreateVolumeRequest {
KmsKeyId?: string;

/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
* <p>The Amazon Resource Name (ARN) of the Outpost on which to create the volume.</p>
* <p>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.</p>
* @public
*/
OutpostArn?: string;
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ec2/src/models/models_5.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2703,7 +2703,7 @@ export interface DescribeVolumesRequest {
Filters?: Filter[];

/**
* <p>The volume IDs.</p>
* <p>The volume IDs. If not specified, then all volumes are included in the response.</p>
* @public
*/
VolumeIds?: string[];
Expand Down
6 changes: 4 additions & 2 deletions clients/client-ec2/src/models/models_6.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5385,8 +5385,9 @@ export interface ModifyInstanceAttributeRequest {
SriovNetSupport?: AttributeValue;

/**
* <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
* can load the text from a file. Otherwise, you must provide base64-encoded text.</p>
* <p>Changes the instance's user data to the specified value. User data must be base64-encoded.
* Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.
* 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>
* @public
*/
UserData?: BlobAttributeValue;
Expand Down Expand Up @@ -6012,6 +6013,7 @@ export interface ModifyInstanceMetadataOptionsResult {
*/
export const HostTenancy = {
dedicated: "dedicated",
default: "default",
host: "host",
} as const;

Expand Down
9 changes: 3 additions & 6 deletions clients/client-ec2/src/models/models_7.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3188,12 +3188,9 @@ export interface RunInstancesRequest {
SubnetId?: string;

/**
* <p>The user data script to make available to the instance. For more information, see
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html">Run
* commands on your Amazon EC2 instance at launch</a> in the <i>Amazon EC2 User
* Guide</i>. If you are using a command line tool, base64-encoding is performed
* for you, and you can load the text from a file. Otherwise, you must provide
* base64-encoded text. User data is limited to 16 KB.</p>
* <p>The user data to make available to the instance. User data must be base64-encoded.
* Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.
* 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>
* @public
*/
UserData?: string;
Expand Down
Loading

0 comments on commit c155b9e

Please sign in to comment.